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