nextcloud /
server
@@ -35,645 +35,645 @@ |
||
| 35 | 35 | * @since 11.0.0 |
| 36 | 36 | */ |
| 37 | 37 | class Definitions { |
| 38 | - /** |
|
| 39 | - * @var array |
|
| 40 | - * @since 11.0.0 |
|
| 41 | - */ |
|
| 42 | - public $definitions = [ |
|
| 43 | - 'addressbook' => [ |
|
| 44 | - 'author' => 'Nextcloud', |
|
| 45 | - 'app' => 'dav', |
|
| 46 | - 'since' => '11.0.0', |
|
| 47 | - 'parameters' => [ |
|
| 48 | - 'id' => [ |
|
| 49 | - 'since' => '11.0.0', |
|
| 50 | - 'required' => true, |
|
| 51 | - 'description' => 'The id used to identify the addressbook on the instance', |
|
| 52 | - 'example' => '42', |
|
| 53 | - ], |
|
| 54 | - 'name' => [ |
|
| 55 | - 'since' => '11.0.0', |
|
| 56 | - 'required' => true, |
|
| 57 | - 'description' => 'The display name of the addressbook which should be used in the visual representation', |
|
| 58 | - 'example' => 'Contacts', |
|
| 59 | - ], |
|
| 60 | - ], |
|
| 61 | - ], |
|
| 62 | - 'addressbook-contact' => [ |
|
| 63 | - 'author' => 'Nextcloud', |
|
| 64 | - 'app' => 'dav', |
|
| 65 | - 'since' => '11.0.0', |
|
| 66 | - 'parameters' => [ |
|
| 67 | - 'id' => [ |
|
| 68 | - 'since' => '11.0.0', |
|
| 69 | - 'required' => true, |
|
| 70 | - 'description' => 'The id used to identify the contact on the instance', |
|
| 71 | - 'example' => '42', |
|
| 72 | - ], |
|
| 73 | - 'name' => [ |
|
| 74 | - 'since' => '11.0.0', |
|
| 75 | - 'required' => true, |
|
| 76 | - 'description' => 'The display name of the contact which should be used in the visual representation', |
|
| 77 | - 'example' => 'John Doe', |
|
| 78 | - ], |
|
| 79 | - ], |
|
| 80 | - ], |
|
| 81 | - 'announcement' => [ |
|
| 82 | - 'author' => 'Joas Schilling', |
|
| 83 | - 'app' => 'announcementcenter', |
|
| 84 | - 'since' => '11.0.0', |
|
| 85 | - 'parameters' => [ |
|
| 86 | - 'id' => [ |
|
| 87 | - 'since' => '11.0.0', |
|
| 88 | - 'required' => true, 'description' => 'The id used to identify the announcement on the instance', |
|
| 89 | - 'example' => '42', |
|
| 90 | - ], |
|
| 91 | - 'name' => [ |
|
| 92 | - 'since' => '11.0.0', |
|
| 93 | - 'required' => true, |
|
| 94 | - 'description' => 'The announcement subject which should be used in the visual representation', |
|
| 95 | - 'example' => 'file.txt', |
|
| 96 | - ], |
|
| 97 | - 'link' => [ |
|
| 98 | - 'since' => '11.0.0', |
|
| 99 | - 'required' => false, |
|
| 100 | - 'description' => 'The full URL to the file', |
|
| 101 | - 'example' => 'http://localhost/index.php/apps/announcements/#23', |
|
| 102 | - ], |
|
| 103 | - ], |
|
| 104 | - ], |
|
| 105 | - 'app' => [ |
|
| 106 | - 'author' => 'Nextcloud', |
|
| 107 | - 'app' => 'updatenotification', |
|
| 108 | - 'since' => '11.0.0', |
|
| 109 | - 'parameters' => [ |
|
| 110 | - 'id' => [ |
|
| 111 | - 'since' => '11.0.0', |
|
| 112 | - 'required' => true, 'description' => 'The app id', |
|
| 113 | - 'example' => 'updatenotification', |
|
| 114 | - ], |
|
| 115 | - 'name' => [ |
|
| 116 | - 'since' => '11.0.0', |
|
| 117 | - 'required' => true, |
|
| 118 | - 'description' => 'The name of the app which should be used in the visual representation', |
|
| 119 | - 'example' => 'Update notification', |
|
| 120 | - ], |
|
| 121 | - ], |
|
| 122 | - ], |
|
| 123 | - 'calendar' => [ |
|
| 124 | - 'author' => 'Nextcloud', |
|
| 125 | - 'app' => 'dav', |
|
| 126 | - 'since' => '11.0.0', |
|
| 127 | - 'parameters' => [ |
|
| 128 | - 'id' => [ |
|
| 129 | - 'since' => '11.0.0', |
|
| 130 | - 'required' => true, |
|
| 131 | - 'description' => 'The id used to identify the calendar on the instance', |
|
| 132 | - 'example' => '42', |
|
| 133 | - ], |
|
| 134 | - 'name' => [ |
|
| 135 | - 'since' => '11.0.0', |
|
| 136 | - 'required' => true, |
|
| 137 | - 'description' => 'The display name of the calendar which should be used in the visual representation', |
|
| 138 | - 'example' => 'Personal', |
|
| 139 | - ], |
|
| 140 | - ], |
|
| 141 | - ], |
|
| 142 | - 'calendar-event' => [ |
|
| 143 | - 'author' => 'Nextcloud', |
|
| 144 | - 'app' => 'dav', |
|
| 145 | - 'since' => '11.0.0', |
|
| 146 | - 'parameters' => [ |
|
| 147 | - 'id' => [ |
|
| 148 | - 'since' => '11.0.0', |
|
| 149 | - 'required' => true, |
|
| 150 | - 'description' => 'The id used to identify the event on the instance', |
|
| 151 | - 'example' => '42', |
|
| 152 | - ], |
|
| 153 | - 'name' => [ |
|
| 154 | - 'since' => '11.0.0', |
|
| 155 | - 'required' => true, |
|
| 156 | - 'description' => 'The display name of the event which should be used in the visual representation', |
|
| 157 | - 'example' => 'Workout', |
|
| 158 | - ], |
|
| 159 | - 'link' => [ |
|
| 160 | - 'since' => '19.0.0', |
|
| 161 | - 'required' => false, |
|
| 162 | - 'description' => 'A link to the page displaying the calendar', |
|
| 163 | - 'example' => 'http://localhost/index.php/apps/calendar/dayGridMonth/2020-01-20/edit/sidebar/base64string/1579046400' |
|
| 164 | - ] |
|
| 165 | - ], |
|
| 166 | - ], |
|
| 167 | - 'call' => [ |
|
| 168 | - 'author' => 'Nextcloud', |
|
| 169 | - 'app' => 'spreed', |
|
| 170 | - 'since' => '11.0.2', |
|
| 171 | - 'parameters' => [ |
|
| 172 | - 'id' => [ |
|
| 173 | - 'since' => '11.0.2', |
|
| 174 | - 'required' => true, |
|
| 175 | - 'description' => 'The id used to identify the call on the instance', |
|
| 176 | - 'example' => '42', |
|
| 177 | - ], |
|
| 178 | - 'name' => [ |
|
| 179 | - 'since' => '11.0.2', |
|
| 180 | - 'required' => true, |
|
| 181 | - 'description' => 'The display name of the call which should be used in the visual representation', |
|
| 182 | - 'example' => 'Company call', |
|
| 183 | - ], |
|
| 184 | - 'call-type' => [ |
|
| 185 | - 'since' => '11.0.2', |
|
| 186 | - 'required' => true, |
|
| 187 | - 'description' => 'The type of the call: one2one, group or public', |
|
| 188 | - 'example' => 'one2one', |
|
| 189 | - ], |
|
| 190 | - 'link' => [ |
|
| 191 | - 'since' => '19.0.0', |
|
| 192 | - 'required' => false, |
|
| 193 | - 'description' => 'The link to the conversation', |
|
| 194 | - 'example' => 'https://localhost/index.php/call/R4nd0mToken', |
|
| 195 | - ], |
|
| 196 | - 'icon-url' => [ |
|
| 197 | - 'since' => '27.0.0', |
|
| 198 | - 'required' => false, |
|
| 199 | - 'description' => 'The icon url to use as avatar', |
|
| 200 | - 'example' => 'https://localhost/ocs/v2.php/apps/spreed/api/v1/room/R4nd0mToken/avatar' |
|
| 201 | - ], |
|
| 202 | - 'message-id' => [ |
|
| 203 | - 'since' => '27.0.0', |
|
| 204 | - 'required' => false, |
|
| 205 | - 'description' => 'The id of a message that was referred to', |
|
| 206 | - 'example' => '12345', |
|
| 207 | - ], |
|
| 208 | - ], |
|
| 209 | - ], |
|
| 210 | - 'circle' => [ |
|
| 211 | - 'author' => 'Maxence Lange', |
|
| 212 | - 'app' => 'circles', |
|
| 213 | - 'since' => '12.0.0', |
|
| 214 | - 'parameters' => [ |
|
| 215 | - 'id' => [ |
|
| 216 | - 'since' => '12.0.0', |
|
| 217 | - 'required' => true, |
|
| 218 | - 'description' => 'The id used to identify the circle on the instance', |
|
| 219 | - 'example' => '42', |
|
| 220 | - ], |
|
| 221 | - 'name' => [ |
|
| 222 | - 'since' => '12.0.0', |
|
| 223 | - 'required' => true, |
|
| 224 | - 'description' => 'The display name of the circle which should be used in the visual representation', |
|
| 225 | - 'example' => 'My friends', |
|
| 226 | - ], |
|
| 227 | - 'link' => [ |
|
| 228 | - 'since' => '12.0.0', |
|
| 229 | - 'required' => true, |
|
| 230 | - 'description' => 'The full URL to the circle', |
|
| 231 | - 'example' => 'http://localhost/index.php/apps/circles/#42', |
|
| 232 | - ], |
|
| 233 | - ], |
|
| 234 | - ], |
|
| 235 | - 'deck-board' => [ |
|
| 236 | - 'author' => 'Nextcloud', |
|
| 237 | - 'app' => 'deck', |
|
| 238 | - 'since' => '21.0.0', |
|
| 239 | - 'parameters' => [ |
|
| 240 | - 'id' => [ |
|
| 241 | - 'since' => '21.0.0', |
|
| 242 | - 'required' => true, |
|
| 243 | - 'description' => 'The id used to identify the board on the instance', |
|
| 244 | - 'example' => '1', |
|
| 245 | - ], |
|
| 246 | - 'name' => [ |
|
| 247 | - 'since' => '21.0.0', |
|
| 248 | - 'required' => true, |
|
| 249 | - 'description' => 'The display name of the deck board', |
|
| 250 | - 'example' => 'Personal', |
|
| 251 | - ], |
|
| 252 | - 'link' => [ |
|
| 253 | - 'since' => '21.0.0', |
|
| 254 | - 'required' => true, |
|
| 255 | - 'description' => 'The full URL to the board', |
|
| 256 | - 'example' => 'http://localhost/index.php/apps/deck/#/board/1', |
|
| 257 | - ], |
|
| 258 | - ], |
|
| 259 | - ], |
|
| 260 | - 'deck-card' => [ |
|
| 261 | - 'author' => 'Nextcloud', |
|
| 262 | - 'app' => 'deck', |
|
| 263 | - 'since' => '21.0.0', |
|
| 264 | - 'parameters' => [ |
|
| 265 | - 'id' => [ |
|
| 266 | - 'since' => '21.0.0', |
|
| 267 | - 'required' => true, |
|
| 268 | - 'description' => 'The id used to identify the card on the instance', |
|
| 269 | - 'example' => '1', |
|
| 270 | - ], |
|
| 271 | - 'name' => [ |
|
| 272 | - 'since' => '21.0.0', |
|
| 273 | - 'required' => true, |
|
| 274 | - 'description' => 'The title of the deck card', |
|
| 275 | - 'example' => 'Foo Bar', |
|
| 276 | - ], |
|
| 277 | - 'boardname' => [ |
|
| 278 | - 'since' => '21.0.0', |
|
| 279 | - 'required' => true, |
|
| 280 | - 'description' => 'The display name of board which contains the card', |
|
| 281 | - 'example' => 'Personal', |
|
| 282 | - ], |
|
| 283 | - 'stackname' => [ |
|
| 284 | - 'since' => '21.0.0', |
|
| 285 | - 'required' => true, |
|
| 286 | - 'description' => 'The display name of the stack which contains the card in the board', |
|
| 287 | - 'example' => 'To do', |
|
| 288 | - ], |
|
| 289 | - 'link' => [ |
|
| 290 | - 'since' => '21.0.0', |
|
| 291 | - 'required' => true, |
|
| 292 | - 'description' => 'The full URL to the card directly', |
|
| 293 | - 'example' => 'https://nextcloud21.local/index.php/apps/deck/#/board/1/card/1', |
|
| 294 | - ], |
|
| 295 | - ], |
|
| 296 | - ], |
|
| 297 | - 'email' => [ |
|
| 298 | - 'author' => 'Nextcloud', |
|
| 299 | - 'app' => 'sharebymail', |
|
| 300 | - 'since' => '11.0.0', |
|
| 301 | - 'parameters' => [ |
|
| 302 | - 'id' => [ |
|
| 303 | - 'since' => '11.0.0', |
|
| 304 | - 'required' => true, |
|
| 305 | - 'description' => 'The mail-address used to identify the event on the instance', |
|
| 306 | - 'example' => 'test@localhost', |
|
| 307 | - ], |
|
| 308 | - 'name' => [ |
|
| 309 | - 'since' => '11.0.0', |
|
| 310 | - 'required' => true, |
|
| 311 | - 'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation', |
|
| 312 | - 'example' => 'Foo Bar', |
|
| 313 | - ], |
|
| 314 | - ], |
|
| 315 | - ], |
|
| 316 | - 'file' => [ |
|
| 317 | - 'author' => 'Nextcloud', |
|
| 318 | - 'app' => 'dav', |
|
| 319 | - 'since' => '11.0.0', |
|
| 320 | - 'parameters' => [ |
|
| 321 | - 'id' => [ |
|
| 322 | - 'since' => '11.0.0', |
|
| 323 | - 'required' => true, |
|
| 324 | - 'description' => 'The id used to identify the file on the instance', |
|
| 325 | - 'example' => '42', |
|
| 326 | - ], |
|
| 327 | - 'name' => [ |
|
| 328 | - 'since' => '11.0.0', |
|
| 329 | - 'required' => true, |
|
| 330 | - 'description' => 'The file name which should be used in the visual representation', |
|
| 331 | - 'example' => 'file.txt', |
|
| 332 | - ], |
|
| 333 | - 'size' => [ |
|
| 334 | - 'since' => '21.0.0', |
|
| 335 | - 'required' => false, |
|
| 336 | - 'description' => 'The file size in bytes', |
|
| 337 | - 'example' => '3145728', |
|
| 338 | - ], |
|
| 339 | - 'path' => [ |
|
| 340 | - 'since' => '11.0.0', |
|
| 341 | - 'required' => true, |
|
| 342 | - 'description' => 'The full path of the file for the user, should not start with a slash', |
|
| 343 | - 'example' => 'path/to/file.txt', |
|
| 344 | - ], |
|
| 345 | - 'link' => [ |
|
| 346 | - 'since' => '11.0.0', |
|
| 347 | - 'required' => false, |
|
| 348 | - 'description' => 'The full URL to the file', |
|
| 349 | - 'example' => 'http://localhost/index.php/f/42', |
|
| 350 | - ], |
|
| 351 | - 'mimetype' => [ |
|
| 352 | - 'since' => '16.0.0', |
|
| 353 | - 'required' => false, |
|
| 354 | - 'description' => 'The mimetype of the file/folder to allow clients to show a placeholder', |
|
| 355 | - 'example' => 'text/plain', |
|
| 356 | - ], |
|
| 357 | - 'preview-available' => [ |
|
| 358 | - 'since' => '16.0.0', |
|
| 359 | - 'required' => false, |
|
| 360 | - 'description' => 'Whether or not a preview is available. If `no` the mimetype icon should be used', |
|
| 361 | - 'example' => 'yes', |
|
| 362 | - ], |
|
| 363 | - 'mtime' => [ |
|
| 364 | - 'since' => '25.0.0', |
|
| 365 | - 'required' => false, |
|
| 366 | - 'description' => 'The mtime of the file/folder as unix timestamp', |
|
| 367 | - 'example' => '1661854213', |
|
| 368 | - ], |
|
| 369 | - ], |
|
| 370 | - ], |
|
| 371 | - 'forms-form' => [ |
|
| 372 | - 'author' => 'Nextcloud', |
|
| 373 | - 'app' => 'forms', |
|
| 374 | - 'since' => '21.0.1', |
|
| 375 | - 'parameters' => [ |
|
| 376 | - 'id' => [ |
|
| 377 | - 'since' => '21.0.1', |
|
| 378 | - 'required' => true, |
|
| 379 | - 'description' => 'The form-hash of the form', |
|
| 380 | - 'example' => 'q72GGqbfbLBC6xNB', |
|
| 381 | - ], |
|
| 382 | - 'name' => [ |
|
| 383 | - 'since' => '21.0.1', |
|
| 384 | - 'required' => true, |
|
| 385 | - 'description' => 'The title of the form', |
|
| 386 | - 'example' => 'Nice Form', |
|
| 387 | - ], |
|
| 388 | - 'link' => [ |
|
| 389 | - 'since' => '21.0.1', |
|
| 390 | - 'required' => true, |
|
| 391 | - 'description' => 'The full URL to the board', |
|
| 392 | - 'example' => 'http://localhost/index.php/apps/forms/q72GGqbfbLBC6xNB', |
|
| 393 | - ], |
|
| 394 | - ], |
|
| 395 | - ], |
|
| 396 | - 'guest' => [ |
|
| 397 | - 'author' => 'Nextcloud', |
|
| 398 | - 'app' => 'spreed', |
|
| 399 | - 'since' => '17.0.0', |
|
| 400 | - 'parameters' => [ |
|
| 401 | - 'id' => [ |
|
| 402 | - 'since' => '17.0.0', |
|
| 403 | - 'required' => true, |
|
| 404 | - 'description' => 'The id used to identify the guest user', |
|
| 405 | - 'example' => '42', |
|
| 406 | - ], |
|
| 407 | - 'name' => [ |
|
| 408 | - 'since' => '17.0.0', |
|
| 409 | - 'required' => true, |
|
| 410 | - 'description' => 'Potential displayname of the guest user', |
|
| 411 | - 'example' => 'Foobar Cats', |
|
| 412 | - ], |
|
| 413 | - ], |
|
| 414 | - ], |
|
| 415 | - 'highlight' => [ |
|
| 416 | - 'author' => 'Nextcloud', |
|
| 417 | - 'app' => 'core', |
|
| 418 | - 'since' => '13.0.0', |
|
| 419 | - 'parameters' => [ |
|
| 420 | - 'id' => [ |
|
| 421 | - 'since' => '13.0.0', |
|
| 422 | - 'required' => true, |
|
| 423 | - 'description' => 'The id used to identify the highlighted object on the instance', |
|
| 424 | - 'example' => '42', |
|
| 425 | - ], |
|
| 426 | - 'name' => [ |
|
| 427 | - 'since' => '13.0.0', |
|
| 428 | - 'required' => true, |
|
| 429 | - 'description' => 'The string that should be highlighted.', |
|
| 430 | - 'example' => 'Hello World', |
|
| 431 | - ], |
|
| 432 | - 'link' => [ |
|
| 433 | - 'since' => '13.0.0', |
|
| 434 | - 'required' => false, |
|
| 435 | - 'description' => 'The full URL that should be opened when clicking the highlighted text.', |
|
| 436 | - 'example' => 'http://localhost/index.php/f/42', |
|
| 437 | - ], |
|
| 438 | - ], |
|
| 439 | - ], |
|
| 440 | - 'geo-location' => [ |
|
| 441 | - 'author' => 'Nextcloud', |
|
| 442 | - 'app' => 'core', |
|
| 443 | - 'since' => '22.0.0', |
|
| 444 | - 'parameters' => [ |
|
| 445 | - 'id' => [ |
|
| 446 | - 'since' => '22.0.0', |
|
| 447 | - 'required' => true, |
|
| 448 | - 'description' => 'The geo URI (https://en.wikipedia.org/wiki/Geo_URI_scheme) to identify the location', |
|
| 449 | - 'example' => 'geo:52.5450511,13.3741463', |
|
| 450 | - ], |
|
| 451 | - 'name' => [ |
|
| 452 | - 'since' => '22.0.0', |
|
| 453 | - 'required' => true, |
|
| 454 | - 'description' => 'A description of the location', |
|
| 455 | - 'example' => 'Nextcloud Berlin Office', |
|
| 456 | - ], |
|
| 457 | - 'latitude' => [ |
|
| 458 | - 'since' => '22.0.0', |
|
| 459 | - 'required' => true, |
|
| 460 | - 'description' => 'The latitude of the location MUST be the same as in the id', |
|
| 461 | - 'example' => '52.5450511', |
|
| 462 | - ], |
|
| 463 | - 'longitude' => [ |
|
| 464 | - 'since' => '22.0.0', |
|
| 465 | - 'required' => true, |
|
| 466 | - 'description' => 'The longitude of the location MUST be the same as in the id', |
|
| 467 | - 'example' => '13.3741463', |
|
| 468 | - ], |
|
| 469 | - ], |
|
| 470 | - ], |
|
| 471 | - 'open-graph' => [ |
|
| 472 | - 'author' => 'Maxence Lange', |
|
| 473 | - 'app' => 'mood', |
|
| 474 | - 'since' => '12.0.0', |
|
| 475 | - 'parameters' => [ |
|
| 476 | - 'id' => [ |
|
| 477 | - 'since' => '12.0.0', |
|
| 478 | - 'required' => true, |
|
| 479 | - 'description' => 'The id used to identify the open graph data on the instance', |
|
| 480 | - 'example' => '42', |
|
| 481 | - ], |
|
| 482 | - 'name' => [ |
|
| 483 | - 'since' => '12.0.0', |
|
| 484 | - 'required' => true, |
|
| 485 | - 'description' => 'The open graph title of the website', |
|
| 486 | - 'example' => 'This is a website', |
|
| 487 | - ], |
|
| 488 | - 'description' => [ |
|
| 489 | - 'since' => '12.0.0', |
|
| 490 | - 'required' => false, |
|
| 491 | - 'description' => 'The open graph description from the website', |
|
| 492 | - 'example' => 'This is the description of the website', |
|
| 493 | - ], |
|
| 494 | - 'thumb' => [ |
|
| 495 | - 'since' => '12.0.0', |
|
| 496 | - 'required' => false, |
|
| 497 | - 'description' => 'The full URL of the open graph thumbnail', |
|
| 498 | - 'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png', |
|
| 499 | - ], |
|
| 500 | - 'website' => [ |
|
| 501 | - 'since' => '12.0.0', |
|
| 502 | - 'required' => false, |
|
| 503 | - 'description' => 'The name of the described website', |
|
| 504 | - 'example' => 'Nextcloud - App Store', |
|
| 505 | - ], |
|
| 506 | - 'link' => [ |
|
| 507 | - 'since' => '12.0.0', |
|
| 508 | - 'required' => false, |
|
| 509 | - 'description' => 'The full link to the website', |
|
| 510 | - 'example' => 'https://apps.nextcloud.com/apps/mood', |
|
| 511 | - ], |
|
| 512 | - ], |
|
| 513 | - ], |
|
| 514 | - 'pending-federated-share' => [ |
|
| 515 | - 'author' => 'Nextcloud', |
|
| 516 | - 'app' => 'dav', |
|
| 517 | - 'since' => '11.0.0', |
|
| 518 | - 'parameters' => [ |
|
| 519 | - 'id' => [ |
|
| 520 | - 'since' => '11.0.0', |
|
| 521 | - 'required' => true, |
|
| 522 | - 'description' => 'The id used to identify the federated share on the instance', |
|
| 523 | - 'example' => '42', |
|
| 524 | - ], |
|
| 525 | - 'name' => [ |
|
| 526 | - 'since' => '11.0.0', |
|
| 527 | - 'required' => true, |
|
| 528 | - 'description' => 'The name of the shared item which should be used in the visual representation', |
|
| 529 | - 'example' => 'file.txt', |
|
| 530 | - ], |
|
| 531 | - ], |
|
| 532 | - ], |
|
| 533 | - 'systemtag' => [ |
|
| 534 | - 'author' => 'Nextcloud', |
|
| 535 | - 'app' => 'core', |
|
| 536 | - 'since' => '11.0.0', |
|
| 537 | - 'parameters' => [ |
|
| 538 | - 'id' => [ |
|
| 539 | - 'since' => '11.0.0', |
|
| 540 | - 'required' => true, |
|
| 541 | - 'description' => 'The id used to identify the systemtag on the instance', |
|
| 542 | - 'example' => '23', |
|
| 543 | - ], |
|
| 544 | - 'name' => [ |
|
| 545 | - 'since' => '11.0.0', |
|
| 546 | - 'required' => true, |
|
| 547 | - 'description' => 'The display name of the systemtag which should be used in the visual representation', |
|
| 548 | - 'example' => 'Project 1', |
|
| 549 | - ], |
|
| 550 | - 'visibility' => [ |
|
| 551 | - 'since' => '11.0.0', |
|
| 552 | - 'required' => true, |
|
| 553 | - 'description' => 'If the user can see the systemtag', |
|
| 554 | - 'example' => '1', |
|
| 555 | - ], |
|
| 556 | - 'assignable' => [ |
|
| 557 | - 'since' => '11.0.0', |
|
| 558 | - 'required' => true, |
|
| 559 | - 'description' => 'If the user can assign the systemtag', |
|
| 560 | - 'example' => '0', |
|
| 561 | - ], |
|
| 562 | - ], |
|
| 563 | - ], |
|
| 564 | - 'talk-attachment' => [ |
|
| 565 | - 'author' => 'Nextcloud', |
|
| 566 | - 'app' => 'talk', |
|
| 567 | - 'since' => '18.0.0', |
|
| 568 | - 'parameters' => [ |
|
| 569 | - 'id' => [ |
|
| 570 | - 'since' => '18.0.0', |
|
| 571 | - 'required' => true, |
|
| 572 | - 'description' => 'The id used to identify the attachment on the instance', |
|
| 573 | - 'example' => '12345', |
|
| 574 | - ], |
|
| 575 | - 'name' => [ |
|
| 576 | - 'since' => '18.0.0', |
|
| 577 | - 'required' => true, |
|
| 578 | - 'description' => 'The name of the attachment', |
|
| 579 | - 'example' => 'John Doe', |
|
| 580 | - ], |
|
| 581 | - 'conversation' => [ |
|
| 582 | - 'since' => '18.0.0', |
|
| 583 | - 'required' => true, |
|
| 584 | - 'description' => 'The token of the conversation', |
|
| 585 | - 'example' => 'a1b2c3d4', |
|
| 586 | - ], |
|
| 587 | - 'mimetype' => [ |
|
| 588 | - 'since' => '18.0.0', |
|
| 589 | - 'required' => false, |
|
| 590 | - 'description' => 'The mimetype of the file/folder to allow clients to show a placeholder', |
|
| 591 | - 'example' => 'text/plain', |
|
| 592 | - ], |
|
| 593 | - 'preview-available' => [ |
|
| 594 | - 'since' => '18.0.0', |
|
| 595 | - 'required' => false, |
|
| 596 | - 'description' => 'Whether or not a preview is available. If `no` the mimetype icon should be used', |
|
| 597 | - 'example' => 'yes', |
|
| 598 | - ], |
|
| 599 | - ], |
|
| 600 | - ], |
|
| 601 | - 'talk-poll' => [ |
|
| 602 | - 'author' => 'Nextcloud', |
|
| 603 | - 'app' => 'talk', |
|
| 604 | - 'since' => '25.0.0', |
|
| 605 | - 'parameters' => [ |
|
| 606 | - 'id' => [ |
|
| 607 | - 'since' => '25.0.0', |
|
| 608 | - 'required' => true, |
|
| 609 | - 'description' => 'The id used to identify the poll on the instance', |
|
| 610 | - 'example' => '12345', |
|
| 611 | - ], |
|
| 612 | - 'name' => [ |
|
| 613 | - 'since' => '25.0.0', |
|
| 614 | - 'required' => true, |
|
| 615 | - 'description' => 'The poll question', |
|
| 616 | - 'example' => 'What is the question?', |
|
| 617 | - ], |
|
| 618 | - ], |
|
| 619 | - ], |
|
| 620 | - 'user' => [ |
|
| 621 | - 'author' => 'Nextcloud', |
|
| 622 | - 'app' => 'core', |
|
| 623 | - 'since' => '11.0.0', |
|
| 624 | - 'parameters' => [ |
|
| 625 | - 'id' => [ |
|
| 626 | - 'since' => '11.0.0', |
|
| 627 | - 'required' => true, |
|
| 628 | - 'description' => 'The id used to identify the user on the instance', |
|
| 629 | - 'example' => 'johndoe', |
|
| 630 | - ], |
|
| 631 | - 'name' => [ |
|
| 632 | - 'since' => '11.0.0', |
|
| 633 | - 'required' => true, |
|
| 634 | - 'description' => 'The display name of the user which should be used in the visual representation', |
|
| 635 | - 'example' => 'John Doe', |
|
| 636 | - ], |
|
| 637 | - 'server' => [ |
|
| 638 | - 'since' => '11.0.0', |
|
| 639 | - 'required' => false, |
|
| 640 | - 'description' => 'The URL of the instance the user lives on', |
|
| 641 | - 'example' => 'localhost', |
|
| 642 | - ], |
|
| 643 | - ], |
|
| 644 | - ], |
|
| 645 | - 'user-group' => [ |
|
| 646 | - 'author' => 'Nextcloud', |
|
| 647 | - 'app' => 'core', |
|
| 648 | - 'since' => '11.0.0', |
|
| 649 | - 'parameters' => [ |
|
| 650 | - 'id' => [ |
|
| 651 | - 'since' => '11.0.0', |
|
| 652 | - 'required' => true, |
|
| 653 | - 'description' => 'The id used to identify the group on the instance', |
|
| 654 | - 'example' => 'supportteam', |
|
| 655 | - ], |
|
| 656 | - 'name' => [ |
|
| 657 | - 'since' => '11.0.0', |
|
| 658 | - 'required' => true, |
|
| 659 | - 'description' => 'The display name of the group which should be used in the visual representation', |
|
| 660 | - 'example' => 'Support Team', |
|
| 661 | - ], |
|
| 662 | - ], |
|
| 663 | - ], |
|
| 664 | - ]; |
|
| 38 | + /** |
|
| 39 | + * @var array |
|
| 40 | + * @since 11.0.0 |
|
| 41 | + */ |
|
| 42 | + public $definitions = [ |
|
| 43 | + 'addressbook' => [ |
|
| 44 | + 'author' => 'Nextcloud', |
|
| 45 | + 'app' => 'dav', |
|
| 46 | + 'since' => '11.0.0', |
|
| 47 | + 'parameters' => [ |
|
| 48 | + 'id' => [ |
|
| 49 | + 'since' => '11.0.0', |
|
| 50 | + 'required' => true, |
|
| 51 | + 'description' => 'The id used to identify the addressbook on the instance', |
|
| 52 | + 'example' => '42', |
|
| 53 | + ], |
|
| 54 | + 'name' => [ |
|
| 55 | + 'since' => '11.0.0', |
|
| 56 | + 'required' => true, |
|
| 57 | + 'description' => 'The display name of the addressbook which should be used in the visual representation', |
|
| 58 | + 'example' => 'Contacts', |
|
| 59 | + ], |
|
| 60 | + ], |
|
| 61 | + ], |
|
| 62 | + 'addressbook-contact' => [ |
|
| 63 | + 'author' => 'Nextcloud', |
|
| 64 | + 'app' => 'dav', |
|
| 65 | + 'since' => '11.0.0', |
|
| 66 | + 'parameters' => [ |
|
| 67 | + 'id' => [ |
|
| 68 | + 'since' => '11.0.0', |
|
| 69 | + 'required' => true, |
|
| 70 | + 'description' => 'The id used to identify the contact on the instance', |
|
| 71 | + 'example' => '42', |
|
| 72 | + ], |
|
| 73 | + 'name' => [ |
|
| 74 | + 'since' => '11.0.0', |
|
| 75 | + 'required' => true, |
|
| 76 | + 'description' => 'The display name of the contact which should be used in the visual representation', |
|
| 77 | + 'example' => 'John Doe', |
|
| 78 | + ], |
|
| 79 | + ], |
|
| 80 | + ], |
|
| 81 | + 'announcement' => [ |
|
| 82 | + 'author' => 'Joas Schilling', |
|
| 83 | + 'app' => 'announcementcenter', |
|
| 84 | + 'since' => '11.0.0', |
|
| 85 | + 'parameters' => [ |
|
| 86 | + 'id' => [ |
|
| 87 | + 'since' => '11.0.0', |
|
| 88 | + 'required' => true, 'description' => 'The id used to identify the announcement on the instance', |
|
| 89 | + 'example' => '42', |
|
| 90 | + ], |
|
| 91 | + 'name' => [ |
|
| 92 | + 'since' => '11.0.0', |
|
| 93 | + 'required' => true, |
|
| 94 | + 'description' => 'The announcement subject which should be used in the visual representation', |
|
| 95 | + 'example' => 'file.txt', |
|
| 96 | + ], |
|
| 97 | + 'link' => [ |
|
| 98 | + 'since' => '11.0.0', |
|
| 99 | + 'required' => false, |
|
| 100 | + 'description' => 'The full URL to the file', |
|
| 101 | + 'example' => 'http://localhost/index.php/apps/announcements/#23', |
|
| 102 | + ], |
|
| 103 | + ], |
|
| 104 | + ], |
|
| 105 | + 'app' => [ |
|
| 106 | + 'author' => 'Nextcloud', |
|
| 107 | + 'app' => 'updatenotification', |
|
| 108 | + 'since' => '11.0.0', |
|
| 109 | + 'parameters' => [ |
|
| 110 | + 'id' => [ |
|
| 111 | + 'since' => '11.0.0', |
|
| 112 | + 'required' => true, 'description' => 'The app id', |
|
| 113 | + 'example' => 'updatenotification', |
|
| 114 | + ], |
|
| 115 | + 'name' => [ |
|
| 116 | + 'since' => '11.0.0', |
|
| 117 | + 'required' => true, |
|
| 118 | + 'description' => 'The name of the app which should be used in the visual representation', |
|
| 119 | + 'example' => 'Update notification', |
|
| 120 | + ], |
|
| 121 | + ], |
|
| 122 | + ], |
|
| 123 | + 'calendar' => [ |
|
| 124 | + 'author' => 'Nextcloud', |
|
| 125 | + 'app' => 'dav', |
|
| 126 | + 'since' => '11.0.0', |
|
| 127 | + 'parameters' => [ |
|
| 128 | + 'id' => [ |
|
| 129 | + 'since' => '11.0.0', |
|
| 130 | + 'required' => true, |
|
| 131 | + 'description' => 'The id used to identify the calendar on the instance', |
|
| 132 | + 'example' => '42', |
|
| 133 | + ], |
|
| 134 | + 'name' => [ |
|
| 135 | + 'since' => '11.0.0', |
|
| 136 | + 'required' => true, |
|
| 137 | + 'description' => 'The display name of the calendar which should be used in the visual representation', |
|
| 138 | + 'example' => 'Personal', |
|
| 139 | + ], |
|
| 140 | + ], |
|
| 141 | + ], |
|
| 142 | + 'calendar-event' => [ |
|
| 143 | + 'author' => 'Nextcloud', |
|
| 144 | + 'app' => 'dav', |
|
| 145 | + 'since' => '11.0.0', |
|
| 146 | + 'parameters' => [ |
|
| 147 | + 'id' => [ |
|
| 148 | + 'since' => '11.0.0', |
|
| 149 | + 'required' => true, |
|
| 150 | + 'description' => 'The id used to identify the event on the instance', |
|
| 151 | + 'example' => '42', |
|
| 152 | + ], |
|
| 153 | + 'name' => [ |
|
| 154 | + 'since' => '11.0.0', |
|
| 155 | + 'required' => true, |
|
| 156 | + 'description' => 'The display name of the event which should be used in the visual representation', |
|
| 157 | + 'example' => 'Workout', |
|
| 158 | + ], |
|
| 159 | + 'link' => [ |
|
| 160 | + 'since' => '19.0.0', |
|
| 161 | + 'required' => false, |
|
| 162 | + 'description' => 'A link to the page displaying the calendar', |
|
| 163 | + 'example' => 'http://localhost/index.php/apps/calendar/dayGridMonth/2020-01-20/edit/sidebar/base64string/1579046400' |
|
| 164 | + ] |
|
| 165 | + ], |
|
| 166 | + ], |
|
| 167 | + 'call' => [ |
|
| 168 | + 'author' => 'Nextcloud', |
|
| 169 | + 'app' => 'spreed', |
|
| 170 | + 'since' => '11.0.2', |
|
| 171 | + 'parameters' => [ |
|
| 172 | + 'id' => [ |
|
| 173 | + 'since' => '11.0.2', |
|
| 174 | + 'required' => true, |
|
| 175 | + 'description' => 'The id used to identify the call on the instance', |
|
| 176 | + 'example' => '42', |
|
| 177 | + ], |
|
| 178 | + 'name' => [ |
|
| 179 | + 'since' => '11.0.2', |
|
| 180 | + 'required' => true, |
|
| 181 | + 'description' => 'The display name of the call which should be used in the visual representation', |
|
| 182 | + 'example' => 'Company call', |
|
| 183 | + ], |
|
| 184 | + 'call-type' => [ |
|
| 185 | + 'since' => '11.0.2', |
|
| 186 | + 'required' => true, |
|
| 187 | + 'description' => 'The type of the call: one2one, group or public', |
|
| 188 | + 'example' => 'one2one', |
|
| 189 | + ], |
|
| 190 | + 'link' => [ |
|
| 191 | + 'since' => '19.0.0', |
|
| 192 | + 'required' => false, |
|
| 193 | + 'description' => 'The link to the conversation', |
|
| 194 | + 'example' => 'https://localhost/index.php/call/R4nd0mToken', |
|
| 195 | + ], |
|
| 196 | + 'icon-url' => [ |
|
| 197 | + 'since' => '27.0.0', |
|
| 198 | + 'required' => false, |
|
| 199 | + 'description' => 'The icon url to use as avatar', |
|
| 200 | + 'example' => 'https://localhost/ocs/v2.php/apps/spreed/api/v1/room/R4nd0mToken/avatar' |
|
| 201 | + ], |
|
| 202 | + 'message-id' => [ |
|
| 203 | + 'since' => '27.0.0', |
|
| 204 | + 'required' => false, |
|
| 205 | + 'description' => 'The id of a message that was referred to', |
|
| 206 | + 'example' => '12345', |
|
| 207 | + ], |
|
| 208 | + ], |
|
| 209 | + ], |
|
| 210 | + 'circle' => [ |
|
| 211 | + 'author' => 'Maxence Lange', |
|
| 212 | + 'app' => 'circles', |
|
| 213 | + 'since' => '12.0.0', |
|
| 214 | + 'parameters' => [ |
|
| 215 | + 'id' => [ |
|
| 216 | + 'since' => '12.0.0', |
|
| 217 | + 'required' => true, |
|
| 218 | + 'description' => 'The id used to identify the circle on the instance', |
|
| 219 | + 'example' => '42', |
|
| 220 | + ], |
|
| 221 | + 'name' => [ |
|
| 222 | + 'since' => '12.0.0', |
|
| 223 | + 'required' => true, |
|
| 224 | + 'description' => 'The display name of the circle which should be used in the visual representation', |
|
| 225 | + 'example' => 'My friends', |
|
| 226 | + ], |
|
| 227 | + 'link' => [ |
|
| 228 | + 'since' => '12.0.0', |
|
| 229 | + 'required' => true, |
|
| 230 | + 'description' => 'The full URL to the circle', |
|
| 231 | + 'example' => 'http://localhost/index.php/apps/circles/#42', |
|
| 232 | + ], |
|
| 233 | + ], |
|
| 234 | + ], |
|
| 235 | + 'deck-board' => [ |
|
| 236 | + 'author' => 'Nextcloud', |
|
| 237 | + 'app' => 'deck', |
|
| 238 | + 'since' => '21.0.0', |
|
| 239 | + 'parameters' => [ |
|
| 240 | + 'id' => [ |
|
| 241 | + 'since' => '21.0.0', |
|
| 242 | + 'required' => true, |
|
| 243 | + 'description' => 'The id used to identify the board on the instance', |
|
| 244 | + 'example' => '1', |
|
| 245 | + ], |
|
| 246 | + 'name' => [ |
|
| 247 | + 'since' => '21.0.0', |
|
| 248 | + 'required' => true, |
|
| 249 | + 'description' => 'The display name of the deck board', |
|
| 250 | + 'example' => 'Personal', |
|
| 251 | + ], |
|
| 252 | + 'link' => [ |
|
| 253 | + 'since' => '21.0.0', |
|
| 254 | + 'required' => true, |
|
| 255 | + 'description' => 'The full URL to the board', |
|
| 256 | + 'example' => 'http://localhost/index.php/apps/deck/#/board/1', |
|
| 257 | + ], |
|
| 258 | + ], |
|
| 259 | + ], |
|
| 260 | + 'deck-card' => [ |
|
| 261 | + 'author' => 'Nextcloud', |
|
| 262 | + 'app' => 'deck', |
|
| 263 | + 'since' => '21.0.0', |
|
| 264 | + 'parameters' => [ |
|
| 265 | + 'id' => [ |
|
| 266 | + 'since' => '21.0.0', |
|
| 267 | + 'required' => true, |
|
| 268 | + 'description' => 'The id used to identify the card on the instance', |
|
| 269 | + 'example' => '1', |
|
| 270 | + ], |
|
| 271 | + 'name' => [ |
|
| 272 | + 'since' => '21.0.0', |
|
| 273 | + 'required' => true, |
|
| 274 | + 'description' => 'The title of the deck card', |
|
| 275 | + 'example' => 'Foo Bar', |
|
| 276 | + ], |
|
| 277 | + 'boardname' => [ |
|
| 278 | + 'since' => '21.0.0', |
|
| 279 | + 'required' => true, |
|
| 280 | + 'description' => 'The display name of board which contains the card', |
|
| 281 | + 'example' => 'Personal', |
|
| 282 | + ], |
|
| 283 | + 'stackname' => [ |
|
| 284 | + 'since' => '21.0.0', |
|
| 285 | + 'required' => true, |
|
| 286 | + 'description' => 'The display name of the stack which contains the card in the board', |
|
| 287 | + 'example' => 'To do', |
|
| 288 | + ], |
|
| 289 | + 'link' => [ |
|
| 290 | + 'since' => '21.0.0', |
|
| 291 | + 'required' => true, |
|
| 292 | + 'description' => 'The full URL to the card directly', |
|
| 293 | + 'example' => 'https://nextcloud21.local/index.php/apps/deck/#/board/1/card/1', |
|
| 294 | + ], |
|
| 295 | + ], |
|
| 296 | + ], |
|
| 297 | + 'email' => [ |
|
| 298 | + 'author' => 'Nextcloud', |
|
| 299 | + 'app' => 'sharebymail', |
|
| 300 | + 'since' => '11.0.0', |
|
| 301 | + 'parameters' => [ |
|
| 302 | + 'id' => [ |
|
| 303 | + 'since' => '11.0.0', |
|
| 304 | + 'required' => true, |
|
| 305 | + 'description' => 'The mail-address used to identify the event on the instance', |
|
| 306 | + 'example' => 'test@localhost', |
|
| 307 | + ], |
|
| 308 | + 'name' => [ |
|
| 309 | + 'since' => '11.0.0', |
|
| 310 | + 'required' => true, |
|
| 311 | + 'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation', |
|
| 312 | + 'example' => 'Foo Bar', |
|
| 313 | + ], |
|
| 314 | + ], |
|
| 315 | + ], |
|
| 316 | + 'file' => [ |
|
| 317 | + 'author' => 'Nextcloud', |
|
| 318 | + 'app' => 'dav', |
|
| 319 | + 'since' => '11.0.0', |
|
| 320 | + 'parameters' => [ |
|
| 321 | + 'id' => [ |
|
| 322 | + 'since' => '11.0.0', |
|
| 323 | + 'required' => true, |
|
| 324 | + 'description' => 'The id used to identify the file on the instance', |
|
| 325 | + 'example' => '42', |
|
| 326 | + ], |
|
| 327 | + 'name' => [ |
|
| 328 | + 'since' => '11.0.0', |
|
| 329 | + 'required' => true, |
|
| 330 | + 'description' => 'The file name which should be used in the visual representation', |
|
| 331 | + 'example' => 'file.txt', |
|
| 332 | + ], |
|
| 333 | + 'size' => [ |
|
| 334 | + 'since' => '21.0.0', |
|
| 335 | + 'required' => false, |
|
| 336 | + 'description' => 'The file size in bytes', |
|
| 337 | + 'example' => '3145728', |
|
| 338 | + ], |
|
| 339 | + 'path' => [ |
|
| 340 | + 'since' => '11.0.0', |
|
| 341 | + 'required' => true, |
|
| 342 | + 'description' => 'The full path of the file for the user, should not start with a slash', |
|
| 343 | + 'example' => 'path/to/file.txt', |
|
| 344 | + ], |
|
| 345 | + 'link' => [ |
|
| 346 | + 'since' => '11.0.0', |
|
| 347 | + 'required' => false, |
|
| 348 | + 'description' => 'The full URL to the file', |
|
| 349 | + 'example' => 'http://localhost/index.php/f/42', |
|
| 350 | + ], |
|
| 351 | + 'mimetype' => [ |
|
| 352 | + 'since' => '16.0.0', |
|
| 353 | + 'required' => false, |
|
| 354 | + 'description' => 'The mimetype of the file/folder to allow clients to show a placeholder', |
|
| 355 | + 'example' => 'text/plain', |
|
| 356 | + ], |
|
| 357 | + 'preview-available' => [ |
|
| 358 | + 'since' => '16.0.0', |
|
| 359 | + 'required' => false, |
|
| 360 | + 'description' => 'Whether or not a preview is available. If `no` the mimetype icon should be used', |
|
| 361 | + 'example' => 'yes', |
|
| 362 | + ], |
|
| 363 | + 'mtime' => [ |
|
| 364 | + 'since' => '25.0.0', |
|
| 365 | + 'required' => false, |
|
| 366 | + 'description' => 'The mtime of the file/folder as unix timestamp', |
|
| 367 | + 'example' => '1661854213', |
|
| 368 | + ], |
|
| 369 | + ], |
|
| 370 | + ], |
|
| 371 | + 'forms-form' => [ |
|
| 372 | + 'author' => 'Nextcloud', |
|
| 373 | + 'app' => 'forms', |
|
| 374 | + 'since' => '21.0.1', |
|
| 375 | + 'parameters' => [ |
|
| 376 | + 'id' => [ |
|
| 377 | + 'since' => '21.0.1', |
|
| 378 | + 'required' => true, |
|
| 379 | + 'description' => 'The form-hash of the form', |
|
| 380 | + 'example' => 'q72GGqbfbLBC6xNB', |
|
| 381 | + ], |
|
| 382 | + 'name' => [ |
|
| 383 | + 'since' => '21.0.1', |
|
| 384 | + 'required' => true, |
|
| 385 | + 'description' => 'The title of the form', |
|
| 386 | + 'example' => 'Nice Form', |
|
| 387 | + ], |
|
| 388 | + 'link' => [ |
|
| 389 | + 'since' => '21.0.1', |
|
| 390 | + 'required' => true, |
|
| 391 | + 'description' => 'The full URL to the board', |
|
| 392 | + 'example' => 'http://localhost/index.php/apps/forms/q72GGqbfbLBC6xNB', |
|
| 393 | + ], |
|
| 394 | + ], |
|
| 395 | + ], |
|
| 396 | + 'guest' => [ |
|
| 397 | + 'author' => 'Nextcloud', |
|
| 398 | + 'app' => 'spreed', |
|
| 399 | + 'since' => '17.0.0', |
|
| 400 | + 'parameters' => [ |
|
| 401 | + 'id' => [ |
|
| 402 | + 'since' => '17.0.0', |
|
| 403 | + 'required' => true, |
|
| 404 | + 'description' => 'The id used to identify the guest user', |
|
| 405 | + 'example' => '42', |
|
| 406 | + ], |
|
| 407 | + 'name' => [ |
|
| 408 | + 'since' => '17.0.0', |
|
| 409 | + 'required' => true, |
|
| 410 | + 'description' => 'Potential displayname of the guest user', |
|
| 411 | + 'example' => 'Foobar Cats', |
|
| 412 | + ], |
|
| 413 | + ], |
|
| 414 | + ], |
|
| 415 | + 'highlight' => [ |
|
| 416 | + 'author' => 'Nextcloud', |
|
| 417 | + 'app' => 'core', |
|
| 418 | + 'since' => '13.0.0', |
|
| 419 | + 'parameters' => [ |
|
| 420 | + 'id' => [ |
|
| 421 | + 'since' => '13.0.0', |
|
| 422 | + 'required' => true, |
|
| 423 | + 'description' => 'The id used to identify the highlighted object on the instance', |
|
| 424 | + 'example' => '42', |
|
| 425 | + ], |
|
| 426 | + 'name' => [ |
|
| 427 | + 'since' => '13.0.0', |
|
| 428 | + 'required' => true, |
|
| 429 | + 'description' => 'The string that should be highlighted.', |
|
| 430 | + 'example' => 'Hello World', |
|
| 431 | + ], |
|
| 432 | + 'link' => [ |
|
| 433 | + 'since' => '13.0.0', |
|
| 434 | + 'required' => false, |
|
| 435 | + 'description' => 'The full URL that should be opened when clicking the highlighted text.', |
|
| 436 | + 'example' => 'http://localhost/index.php/f/42', |
|
| 437 | + ], |
|
| 438 | + ], |
|
| 439 | + ], |
|
| 440 | + 'geo-location' => [ |
|
| 441 | + 'author' => 'Nextcloud', |
|
| 442 | + 'app' => 'core', |
|
| 443 | + 'since' => '22.0.0', |
|
| 444 | + 'parameters' => [ |
|
| 445 | + 'id' => [ |
|
| 446 | + 'since' => '22.0.0', |
|
| 447 | + 'required' => true, |
|
| 448 | + 'description' => 'The geo URI (https://en.wikipedia.org/wiki/Geo_URI_scheme) to identify the location', |
|
| 449 | + 'example' => 'geo:52.5450511,13.3741463', |
|
| 450 | + ], |
|
| 451 | + 'name' => [ |
|
| 452 | + 'since' => '22.0.0', |
|
| 453 | + 'required' => true, |
|
| 454 | + 'description' => 'A description of the location', |
|
| 455 | + 'example' => 'Nextcloud Berlin Office', |
|
| 456 | + ], |
|
| 457 | + 'latitude' => [ |
|
| 458 | + 'since' => '22.0.0', |
|
| 459 | + 'required' => true, |
|
| 460 | + 'description' => 'The latitude of the location MUST be the same as in the id', |
|
| 461 | + 'example' => '52.5450511', |
|
| 462 | + ], |
|
| 463 | + 'longitude' => [ |
|
| 464 | + 'since' => '22.0.0', |
|
| 465 | + 'required' => true, |
|
| 466 | + 'description' => 'The longitude of the location MUST be the same as in the id', |
|
| 467 | + 'example' => '13.3741463', |
|
| 468 | + ], |
|
| 469 | + ], |
|
| 470 | + ], |
|
| 471 | + 'open-graph' => [ |
|
| 472 | + 'author' => 'Maxence Lange', |
|
| 473 | + 'app' => 'mood', |
|
| 474 | + 'since' => '12.0.0', |
|
| 475 | + 'parameters' => [ |
|
| 476 | + 'id' => [ |
|
| 477 | + 'since' => '12.0.0', |
|
| 478 | + 'required' => true, |
|
| 479 | + 'description' => 'The id used to identify the open graph data on the instance', |
|
| 480 | + 'example' => '42', |
|
| 481 | + ], |
|
| 482 | + 'name' => [ |
|
| 483 | + 'since' => '12.0.0', |
|
| 484 | + 'required' => true, |
|
| 485 | + 'description' => 'The open graph title of the website', |
|
| 486 | + 'example' => 'This is a website', |
|
| 487 | + ], |
|
| 488 | + 'description' => [ |
|
| 489 | + 'since' => '12.0.0', |
|
| 490 | + 'required' => false, |
|
| 491 | + 'description' => 'The open graph description from the website', |
|
| 492 | + 'example' => 'This is the description of the website', |
|
| 493 | + ], |
|
| 494 | + 'thumb' => [ |
|
| 495 | + 'since' => '12.0.0', |
|
| 496 | + 'required' => false, |
|
| 497 | + 'description' => 'The full URL of the open graph thumbnail', |
|
| 498 | + 'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png', |
|
| 499 | + ], |
|
| 500 | + 'website' => [ |
|
| 501 | + 'since' => '12.0.0', |
|
| 502 | + 'required' => false, |
|
| 503 | + 'description' => 'The name of the described website', |
|
| 504 | + 'example' => 'Nextcloud - App Store', |
|
| 505 | + ], |
|
| 506 | + 'link' => [ |
|
| 507 | + 'since' => '12.0.0', |
|
| 508 | + 'required' => false, |
|
| 509 | + 'description' => 'The full link to the website', |
|
| 510 | + 'example' => 'https://apps.nextcloud.com/apps/mood', |
|
| 511 | + ], |
|
| 512 | + ], |
|
| 513 | + ], |
|
| 514 | + 'pending-federated-share' => [ |
|
| 515 | + 'author' => 'Nextcloud', |
|
| 516 | + 'app' => 'dav', |
|
| 517 | + 'since' => '11.0.0', |
|
| 518 | + 'parameters' => [ |
|
| 519 | + 'id' => [ |
|
| 520 | + 'since' => '11.0.0', |
|
| 521 | + 'required' => true, |
|
| 522 | + 'description' => 'The id used to identify the federated share on the instance', |
|
| 523 | + 'example' => '42', |
|
| 524 | + ], |
|
| 525 | + 'name' => [ |
|
| 526 | + 'since' => '11.0.0', |
|
| 527 | + 'required' => true, |
|
| 528 | + 'description' => 'The name of the shared item which should be used in the visual representation', |
|
| 529 | + 'example' => 'file.txt', |
|
| 530 | + ], |
|
| 531 | + ], |
|
| 532 | + ], |
|
| 533 | + 'systemtag' => [ |
|
| 534 | + 'author' => 'Nextcloud', |
|
| 535 | + 'app' => 'core', |
|
| 536 | + 'since' => '11.0.0', |
|
| 537 | + 'parameters' => [ |
|
| 538 | + 'id' => [ |
|
| 539 | + 'since' => '11.0.0', |
|
| 540 | + 'required' => true, |
|
| 541 | + 'description' => 'The id used to identify the systemtag on the instance', |
|
| 542 | + 'example' => '23', |
|
| 543 | + ], |
|
| 544 | + 'name' => [ |
|
| 545 | + 'since' => '11.0.0', |
|
| 546 | + 'required' => true, |
|
| 547 | + 'description' => 'The display name of the systemtag which should be used in the visual representation', |
|
| 548 | + 'example' => 'Project 1', |
|
| 549 | + ], |
|
| 550 | + 'visibility' => [ |
|
| 551 | + 'since' => '11.0.0', |
|
| 552 | + 'required' => true, |
|
| 553 | + 'description' => 'If the user can see the systemtag', |
|
| 554 | + 'example' => '1', |
|
| 555 | + ], |
|
| 556 | + 'assignable' => [ |
|
| 557 | + 'since' => '11.0.0', |
|
| 558 | + 'required' => true, |
|
| 559 | + 'description' => 'If the user can assign the systemtag', |
|
| 560 | + 'example' => '0', |
|
| 561 | + ], |
|
| 562 | + ], |
|
| 563 | + ], |
|
| 564 | + 'talk-attachment' => [ |
|
| 565 | + 'author' => 'Nextcloud', |
|
| 566 | + 'app' => 'talk', |
|
| 567 | + 'since' => '18.0.0', |
|
| 568 | + 'parameters' => [ |
|
| 569 | + 'id' => [ |
|
| 570 | + 'since' => '18.0.0', |
|
| 571 | + 'required' => true, |
|
| 572 | + 'description' => 'The id used to identify the attachment on the instance', |
|
| 573 | + 'example' => '12345', |
|
| 574 | + ], |
|
| 575 | + 'name' => [ |
|
| 576 | + 'since' => '18.0.0', |
|
| 577 | + 'required' => true, |
|
| 578 | + 'description' => 'The name of the attachment', |
|
| 579 | + 'example' => 'John Doe', |
|
| 580 | + ], |
|
| 581 | + 'conversation' => [ |
|
| 582 | + 'since' => '18.0.0', |
|
| 583 | + 'required' => true, |
|
| 584 | + 'description' => 'The token of the conversation', |
|
| 585 | + 'example' => 'a1b2c3d4', |
|
| 586 | + ], |
|
| 587 | + 'mimetype' => [ |
|
| 588 | + 'since' => '18.0.0', |
|
| 589 | + 'required' => false, |
|
| 590 | + 'description' => 'The mimetype of the file/folder to allow clients to show a placeholder', |
|
| 591 | + 'example' => 'text/plain', |
|
| 592 | + ], |
|
| 593 | + 'preview-available' => [ |
|
| 594 | + 'since' => '18.0.0', |
|
| 595 | + 'required' => false, |
|
| 596 | + 'description' => 'Whether or not a preview is available. If `no` the mimetype icon should be used', |
|
| 597 | + 'example' => 'yes', |
|
| 598 | + ], |
|
| 599 | + ], |
|
| 600 | + ], |
|
| 601 | + 'talk-poll' => [ |
|
| 602 | + 'author' => 'Nextcloud', |
|
| 603 | + 'app' => 'talk', |
|
| 604 | + 'since' => '25.0.0', |
|
| 605 | + 'parameters' => [ |
|
| 606 | + 'id' => [ |
|
| 607 | + 'since' => '25.0.0', |
|
| 608 | + 'required' => true, |
|
| 609 | + 'description' => 'The id used to identify the poll on the instance', |
|
| 610 | + 'example' => '12345', |
|
| 611 | + ], |
|
| 612 | + 'name' => [ |
|
| 613 | + 'since' => '25.0.0', |
|
| 614 | + 'required' => true, |
|
| 615 | + 'description' => 'The poll question', |
|
| 616 | + 'example' => 'What is the question?', |
|
| 617 | + ], |
|
| 618 | + ], |
|
| 619 | + ], |
|
| 620 | + 'user' => [ |
|
| 621 | + 'author' => 'Nextcloud', |
|
| 622 | + 'app' => 'core', |
|
| 623 | + 'since' => '11.0.0', |
|
| 624 | + 'parameters' => [ |
|
| 625 | + 'id' => [ |
|
| 626 | + 'since' => '11.0.0', |
|
| 627 | + 'required' => true, |
|
| 628 | + 'description' => 'The id used to identify the user on the instance', |
|
| 629 | + 'example' => 'johndoe', |
|
| 630 | + ], |
|
| 631 | + 'name' => [ |
|
| 632 | + 'since' => '11.0.0', |
|
| 633 | + 'required' => true, |
|
| 634 | + 'description' => 'The display name of the user which should be used in the visual representation', |
|
| 635 | + 'example' => 'John Doe', |
|
| 636 | + ], |
|
| 637 | + 'server' => [ |
|
| 638 | + 'since' => '11.0.0', |
|
| 639 | + 'required' => false, |
|
| 640 | + 'description' => 'The URL of the instance the user lives on', |
|
| 641 | + 'example' => 'localhost', |
|
| 642 | + ], |
|
| 643 | + ], |
|
| 644 | + ], |
|
| 645 | + 'user-group' => [ |
|
| 646 | + 'author' => 'Nextcloud', |
|
| 647 | + 'app' => 'core', |
|
| 648 | + 'since' => '11.0.0', |
|
| 649 | + 'parameters' => [ |
|
| 650 | + 'id' => [ |
|
| 651 | + 'since' => '11.0.0', |
|
| 652 | + 'required' => true, |
|
| 653 | + 'description' => 'The id used to identify the group on the instance', |
|
| 654 | + 'example' => 'supportteam', |
|
| 655 | + ], |
|
| 656 | + 'name' => [ |
|
| 657 | + 'since' => '11.0.0', |
|
| 658 | + 'required' => true, |
|
| 659 | + 'description' => 'The display name of the group which should be used in the visual representation', |
|
| 660 | + 'example' => 'Support Team', |
|
| 661 | + ], |
|
| 662 | + ], |
|
| 663 | + ], |
|
| 664 | + ]; |
|
| 665 | 665 | |
| 666 | - /** |
|
| 667 | - * @param string $type |
|
| 668 | - * @return array |
|
| 669 | - * @throws InvalidObjectExeption |
|
| 670 | - * @since 11.0.0 |
|
| 671 | - */ |
|
| 672 | - public function getDefinition($type) { |
|
| 673 | - if (isset($this->definitions[$type])) { |
|
| 674 | - return $this->definitions[$type]; |
|
| 675 | - } |
|
| 666 | + /** |
|
| 667 | + * @param string $type |
|
| 668 | + * @return array |
|
| 669 | + * @throws InvalidObjectExeption |
|
| 670 | + * @since 11.0.0 |
|
| 671 | + */ |
|
| 672 | + public function getDefinition($type) { |
|
| 673 | + if (isset($this->definitions[$type])) { |
|
| 674 | + return $this->definitions[$type]; |
|
| 675 | + } |
|
| 676 | 676 | |
| 677 | - throw new InvalidObjectExeption('Object type is undefined'); |
|
| 678 | - } |
|
| 677 | + throw new InvalidObjectExeption('Object type is undefined'); |
|
| 678 | + } |
|
| 679 | 679 | } |
