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
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* Public interface of ownCloud for apps to use.
* Activity/IEvent interface
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Activity;
/**
* Interface IEvent
*
* @package OCP\Activity
* @since 8.2.0
*/
interface IEvent {
/**
* Set the app of the activity
*
* @param string $app
* @return IEvent
* @throws \InvalidArgumentException if the app id is invalid
* @since 8.2.0
*/
public function setApp($app);
/**
* Set the type of the activity
*
* @param string $type
* @return IEvent
* @throws \InvalidArgumentException if the type is invalid
* @since 8.2.0
*/
public function setType($type);
/**
* Set the affected user of the activity
*
* @param string $user
* @return IEvent
* @throws \InvalidArgumentException if the affected user is invalid
* @since 8.2.0
*/
public function setAffectedUser($user);
/**
* Set the author of the activity
*
* @param string $author
* @return IEvent
* @throws \InvalidArgumentException if the author is invalid
* @since 8.2.0
*/
public function setAuthor($author);
/**
* Set the author of the activity
*
* @param int $timestamp
* @return IEvent
* @throws \InvalidArgumentException if the timestamp is invalid
* @since 8.2.0
*/
public function setTimestamp($timestamp);
/**
* Set the subject of the activity
*
* @param string $subject
* @param array $parameters
* @return IEvent
* @throws \InvalidArgumentException if the subject or parameters are invalid
* @since 8.2.0
*/
public function setSubject($subject, array $parameters = []);
/**
* @param string $subject
* @return $this
* @throws \InvalidArgumentException if the subject is invalid
* @since 9.2.0
*/
public function setParsedSubject($subject);
/**
* @return string
* @since 9.2.0
*/
public function getParsedSubject();
/**
* @param string $subject
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
* @since 9.2.0
*/
public function setRichSubject($subject, array $parameters = []);
/**
* @return string
* @since 9.2.0
*/
public function getRichSubject();
/**
* @return array[]
* @since 9.2.0
*/
public function getRichSubjectParameters();
/**
* Set the message of the activity
*
* @param string $message
* @param array $parameters
* @return IEvent
* @throws \InvalidArgumentException if the message or parameters are invalid
* @since 8.2.0
*/
public function setMessage($message, array $parameters = []);
/**
* @param string $message
* @return $this
* @throws \InvalidArgumentException if the message is invalid
* @since 9.2.0
*/
public function setParsedMessage($message);
/**
* @return string
* @since 9.2.0
*/
public function getParsedMessage();
/**
* @param string $message
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
* @since 9.2.0
*/
public function setRichMessage($message, array $parameters = []);
/**
* @return string
* @since 9.2.0
*/
public function getRichMessage();
/**
* @return array[]
* @since 9.2.0
*/
public function getRichMessageParameters();
/**
* Set the object of the activity
*
* @param string $objectType
* @param int $objectId
* @param string $objectName
* @return IEvent
* @throws \InvalidArgumentException if the object is invalid
* @since 8.2.0
*/
public function setObject($objectType, $objectId, $objectName = '');
/**
* Set the link of the activity
*
* @param string $link
* @return IEvent
* @throws \InvalidArgumentException if the link is invalid
* @since 8.2.0
*/
public function setLink($link);
/**
* @return string
* @since 8.2.0
*/
public function getApp();
/**
* @return string
* @since 8.2.0
*/
public function getType();
/**
* @return string
* @since 8.2.0
*/
public function getAffectedUser();
/**
* @return string
* @since 8.2.0
*/
public function getAuthor();
/**
* @return int
* @since 8.2.0
*/
public function getTimestamp();
/**
* @return string
* @since 8.2.0
*/
public function getSubject();
/**
* @return array
* @since 8.2.0
*/
public function getSubjectParameters();
/**
* @return string
* @since 8.2.0
*/
public function getMessage();
/**
* @return array
* @since 8.2.0
*/
public function getMessageParameters();
/**
* @return string
* @since 8.2.0
*/
public function getObjectType();
/**
* @return string
* @since 8.2.0
*/
public function getObjectId();
/**
* @return string
* @since 8.2.0
*/
public function getObjectName();
/**
* @return string
* @since 8.2.0
*/
public function getLink();
/**
* @param string $icon
* @return $this
* @throws \InvalidArgumentException if the icon is invalid
* @since 9.2.0
*/
public function setIcon($icon);
/**
* @return string
* @since 9.2.0
*/
public function getIcon();
/**
* @param IEvent $child
* @since 9.2.0
*/
public function setChildEvent(IEvent $child);
/**
* @return IEvent|null
* @since 9.2.0
*/
public function getChildEvent();
/**
* @return bool
* @since 9.2.0
*/
public function isValid();
/**
* @return bool
* @since 9.2.0
*/
public function isValidParsed();
}
|