blob: 2d8557ec64da8edef9508e8ef193e86ccff0fb2f (
plain)
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
|
<?php
/**
* @author Joas Schilling <nickvergessen@owncloud.com>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @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/>
*
*/
namespace OCP\Notification;
/**
* Interface INotification
*
* @package OCP\Notification
* @since 9.0.0
*/
interface INotification {
/**
* @param string $app
* @return $this
* @throws \InvalidArgumentException if the app id are invalid
* @since 9.0.0
*/
public function setApp($app);
/**
* @return string
* @since 9.0.0
*/
public function getApp();
/**
* @param string $user
* @return $this
* @throws \InvalidArgumentException if the user id are invalid
* @since 9.0.0
*/
public function setUser($user);
/**
* @return string
* @since 9.0.0
*/
public function getUser();
/**
* @param \DateTime $dateTime
* @return $this
* @throws \InvalidArgumentException if the $dateTime is invalid
* @since 9.0.0
*/
public function setDateTime(\DateTime $dateTime);
/**
* @return \DateTime
* @since 9.0.0
*/
public function getDateTime();
/**
* @param string $type
* @param string $id
* @return $this
* @throws \InvalidArgumentException if the object type or id is invalid
* @since 9.0.0
*/
public function setObject($type, $id);
/**
* @return string
* @since 9.0.0
*/
public function getObjectType();
/**
* @return string
* @since 9.0.0
*/
public function getObjectId();
/**
* @param string $subject
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
* @since 9.0.0
*/
public function setSubject($subject, array $parameters = []);
/**
* @return string
* @since 9.0.0
*/
public function getSubject();
/**
* @return string[]
* @since 9.0.0
*/
public function getSubjectParameters();
/**
* @param string $subject
* @return $this
* @throws \InvalidArgumentException if the subject are invalid
* @since 9.0.0
*/
public function setParsedSubject($subject);
/**
* @return string
* @since 9.0.0
*/
public function getParsedSubject();
/**
* @param string $message
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
* @since 9.0.0
*/
public function setMessage($message, array $parameters = []);
/**
* @return string
* @since 9.0.0
*/
public function getMessage();
/**
* @return string[]
* @since 9.0.0
*/
public function getMessageParameters();
/**
* @param string $message
* @return $this
* @throws \InvalidArgumentException if the message are invalid
* @since 9.0.0
*/
public function setParsedMessage($message);
/**
* @return string
* @since 9.0.0
*/
public function getParsedMessage();
/**
* @param string $link
* @return $this
* @throws \InvalidArgumentException if the link are invalid
* @since 9.0.0
*/
public function setLink($link);
/**
* @return string
* @since 9.0.0
*/
public function getLink();
/**
* @return IAction
* @since 9.0.0
*/
public function createAction();
/**
* @param IAction $action
* @return $this
* @throws \InvalidArgumentException if the action are invalid
* @since 9.0.0
*/
public function addAction(IAction $action);
/**
* @return IAction[]
* @since 9.0.0
*/
public function getActions();
/**
* @param IAction $action
* @return $this
* @throws \InvalidArgumentException if the action are invalid
* @since 9.0.0
*/
public function addParsedAction(IAction $action);
/**
* @return IAction[]
* @since 9.0.0
*/
public function getParsedActions();
/**
* @return bool
* @since 9.0.0
*/
public function isValid();
/**
* @return bool
* @since 9.0.0
*/
public function isValidParsed();
}
|
