1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
<?php
/**
* @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\RichObjectStrings;
/**
* Class Definitions
*
* @package OCP\RichObjectStrings
* @since 11.0.0
*/
class Definitions {
/**
* @var array
* @since 11.0.0
*/
public $definitions = [
'addressbook' => [
'author' => 'Nextcloud',
'app' => 'dav',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the addressbook on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the addressbook which should be used in the visual representation',
'example' => 'Contacts',
],
],
],
'addressbook-contact' => [
'author' => 'Nextcloud',
'app' => 'dav',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the contact on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the contact which should be used in the visual representation',
'example' => 'John Doe',
],
],
],
'announcement' => [
'author' => 'Joas Schilling',
'app' => 'announcementcenter',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true, 'description' => 'The id used to identify the announcement on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The announcement subject which should be used in the visual representation',
'example' => 'file.txt',
],
'link' => [
'since' => '11.0.0',
'required' => false,
'description' => 'The full URL to the file',
'example' => 'http://localhost/index.php/apps/announcements/#23',
],
],
],
'app' => [
'author' => 'Nextcloud',
'app' => 'updatenotification',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true, 'description' => 'The app id',
'example' => 'updatenotification',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The name of the app which should be used in the visual representation',
'example' => 'Update notification',
],
],
],
'calendar' => [
'author' => 'Nextcloud',
'app' => 'dav',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the calendar on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the calendar which should be used in the visual representation',
'example' => 'Personal',
],
],
],
'calendar-event' => [
'author' => 'Nextcloud',
'app' => 'dav',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the event on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the event which should be used in the visual representation',
'example' => 'Workout',
],
],
],
'call' => [
'author' => 'Nextcloud',
'app' => 'spreed',
'since' => '11.0.2',
'parameters' => [
'id' => [
'since' => '11.0.2',
'required' => true,
'description' => 'The id used to identify the call on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.2',
'required' => true,
'description' => 'The display name of the call which should be used in the visual representation',
'example' => 'Company call',
],
'call-type' => [
'since' => '11.0.2',
'required' => true,
'description' => 'The type of the call: one2one, group or public',
'example' => 'one2one',
],
],
],
'email' => [
'author' => 'Nextcloud',
'app' => 'sharebymail',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The mail-address used to identify the event on the instance',
'example' => 'test@localhost',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation',
'example' => 'Foo Bar',
],
],
],
'file' => [
'author' => 'Nextcloud',
'app' => 'dav',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the file on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The file name which should be used in the visual representation',
'example' => 'file.txt',
],
'path' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The full path of the file for the user, should not start with a slash',
'example' => 'path/to/file.txt',
],
'link' => [
'since' => '11.0.0',
'required' => false,
'description' => 'The full URL to the file',
'example' => 'http://localhost/index.php/f/42',
],
],
],
'open-graph' => [
'author' => 'Nextcloud',
'app' => 'mood',
'since' => '12.0.0',
'parameters' => [
'id' => [
'since' => '12.0.0',
'required' => true,
'description' => 'The id used to identify the open graph data on the instance',
'example' => '42',
],
'thumb' => [
'since' => '12.0.0',
'required' => false,
'description' => 'The full URL of the open graph thumbnail',
'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png',
],
'title' => [
'since' => '12.0.0',
'required' => true,
'description' => 'The open graph title from the website',
'example' => 'This is a website',
],
'description' => [
'since' => '12.0.0',
'required' => false,
'description' => 'The open graph description from the website',
'example' => 'This is the description of the website',
],
'website' => [
'since' => '12.0.0',
'required' => false,
'description' => 'The name of the described website',
'example' => 'Nextcloud - App Store',
],
'link' => [
'since' => '12.0.0',
'required' => false,
'description' => 'The full link to the website',
'example' => 'https://apps.nextcloud.com/apps/mood',
],
],
],
'pending-federated-share' => [
'author' => 'Nextcloud',
'app' => 'dav',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the federated share on the instance',
'example' => '42',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The name of the shared item which should be used in the visual representation',
'example' => 'file.txt',
],
],
],
'systemtag' => [
'author' => 'Nextcloud',
'app' => 'core',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the systemtag on the instance',
'example' => '23',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the systemtag which should be used in the visual representation',
'example' => 'Project 1',
],
'visibility' => [
'since' => '11.0.0',
'required' => true,
'description' => 'If the user can see the systemtag',
'example' => '1',
],
'assignable' => [
'since' => '11.0.0',
'required' => true,
'description' => 'If the user can assign the systemtag',
'example' => '0',
],
],
],
'user' => [
'author' => 'Nextcloud',
'app' => 'core',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the user on the instance',
'example' => 'johndoe',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the user which should be used in the visual representation',
'example' => 'John Doe',
],
'server' => [
'since' => '11.0.0',
'required' => false,
'description' => 'The URL of the instance the user lives on',
'example' => 'localhost',
],
],
],
'user-group' => [
'author' => 'Nextcloud',
'app' => 'core',
'since' => '11.0.0',
'parameters' => [
'id' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The id used to identify the group on the instance',
'example' => 'supportteam',
],
'name' => [
'since' => '11.0.0',
'required' => true,
'description' => 'The display name of the group which should be used in the visual representation',
'example' => 'Support Team',
],
],
],
];
/**
* @param string $type
* @return array
* @throws InvalidObjectExeption
* @since 11.0.0
*/
public function getDefinition($type) {
if (isset($this->definitions[$type])) {
return $this->definitions[$type];
}
throw new InvalidObjectExeption('Object type is undefined');
}
}
|
