ResponseDefinitions.php 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
  5. *
  6. * @author Kate Döen <kate.doeen@nextcloud.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCA\Core;
  25. /**
  26. * @psalm-type CoreLoginFlowV2Credentials = array{
  27. * server: string,
  28. * loginName: string,
  29. * appPassword: string,
  30. * }
  31. *
  32. * @psalm-type CoreLoginFlowV2 = array{
  33. * poll: array{
  34. * token: string,
  35. * endpoint: string,
  36. * },
  37. * login: string,
  38. * }
  39. *
  40. * @psalm-type CoreNavigationEntry = array{
  41. * id: string,
  42. * order?: int,
  43. * href: string,
  44. * icon: string,
  45. * type: string,
  46. * name: string,
  47. * app?: string,
  48. * default?: bool,
  49. * active: bool,
  50. * classes: string,
  51. * unread: int,
  52. * }
  53. *
  54. * @psalm-type CoreContactsAction = array{
  55. * title: string,
  56. * icon: string,
  57. * hyperlink: string,
  58. * appId: string,
  59. * }
  60. *
  61. * @psalm-type CoreOpenGraphObject = array{
  62. * id: string,
  63. * name: string,
  64. * description: ?string,
  65. * thumb: ?string,
  66. * link: string,
  67. * }
  68. *
  69. * @psalm-type CoreResource = array{
  70. * richObjectType: string,
  71. * richObject: array<string, ?mixed>,
  72. * openGraphObject: CoreOpenGraphObject,
  73. * accessible: bool,
  74. * }
  75. *
  76. * @psalm-type CoreCollection = array{
  77. * id: int,
  78. * name: string,
  79. * resources: CoreResource[],
  80. * }
  81. *
  82. * @psalm-type CoreReference = array{
  83. * richObjectType: string,
  84. * richObject: array<string, ?mixed>,
  85. * openGraphObject: CoreOpenGraphObject,
  86. * accessible: bool,
  87. * }
  88. *
  89. * @psalm-type CoreReferenceProvider = array{
  90. * id: string,
  91. * title: string,
  92. * icon_url: string,
  93. * order: int,
  94. * search_providers_ids: ?string[]
  95. * }
  96. *
  97. * @psalm-type CoreUnifiedSearchProvider = array{
  98. * id: string,
  99. * appId: string,
  100. * name: string,
  101. * icon: string,
  102. * order: int,
  103. * triggers: string[],
  104. * filters: array<string, string>,
  105. * inAppSearch: bool,
  106. * }
  107. *
  108. * @psalm-type CoreUnifiedSearchResultEntry = array{
  109. * thumbnailUrl: string,
  110. * title: string,
  111. * subline: string,
  112. * resourceUrl: string,
  113. * icon: string,
  114. * rounded: bool,
  115. * attributes: string[],
  116. * }
  117. *
  118. * @psalm-type CoreUnifiedSearchResult = array{
  119. * name: string,
  120. * isPaginated: bool,
  121. * entries: CoreUnifiedSearchResultEntry[],
  122. * cursor: int|string|null,
  123. * }
  124. *
  125. * @psalm-type CoreAutocompleteResult = array{
  126. * id: string,
  127. * label: string,
  128. * icon: string,
  129. * source: string,
  130. * status: array{
  131. * status: string,
  132. * message: ?string,
  133. * icon: ?string,
  134. * clearAt: ?int,
  135. * }|string,
  136. * subline: string,
  137. * shareWithDisplayNameUnique: string,
  138. * }
  139. *
  140. * @psalm-type CoreTextProcessingTask = array{
  141. * id: ?int,
  142. * type: string,
  143. * status: 0|1|2|3|4,
  144. * userId: ?string,
  145. * appId: string,
  146. * input: string,
  147. * output: ?string,
  148. * identifier: string,
  149. * completionExpectedAt: ?int
  150. * }
  151. *
  152. * @psalm-type CoreTextToImageTask = array{
  153. * id: ?int,
  154. * status: 0|1|2|3|4,
  155. * userId: ?string,
  156. * appId: string,
  157. * input: string,
  158. * identifier: ?string,
  159. * numberOfImages: int,
  160. * completionExpectedAt: ?int,
  161. * }
  162. */
  163. class ResponseDefinitions {
  164. }