NotificationAlertWeb.php — Brevo – Email, SMS, Web Push, Chat, and more. 3.2.0

mailin / wonderpush-php-lib / lib / Obj / NotificationAlertWeb.php

mailin / wonderpush-php-lib / lib / Obj Last commit date

NotificationAlertWeb.php

305 lines

1	<?php
2
3	namespace WonderPush\Obj;
4
5	if (count(get_included_files()) === 1) { http_response_code(403); exit(); } // Prevent direct access
6
7	/**
8	* DTO part for `notification.alert.web`.
9	* @see NotificationAlert
10	* @codeCoverageIgnore
11	*/
12	class NotificationAlertWeb extends NotificationAlert {
13
14	// title is already present in the platform-independent parent object
15	/** @var string */
16	private $dir;
17	/** @var string */
18	private $lang;
19	/** @var string */
20	private $body;
21	/** @var string */
22	private $tag;
23	/** @var string */
24	private $icon;
25	/** @var string */
26	private $badge;
27	/** @var string */
28	private $image;
29	/** @var string */
30	private $sound;
31	/** @var integer[] */
32	private $vibrate;
33	/** @var integer */
34	private $timestamp;
35	/** @var boolean */
36	private $renotify;
37	/** @var boolean */
38	private $silent;
39	/** @var boolean */
40	private $noscreen;
41	/** @var boolean */
42	private $requireInteraction;
43	/** @var boolean */
44	private $sticky;
45	/** @var NotificationAlertWebButton[] */
46	private $buttons; // actual name is `actions`, but it clashes with "on click background actions"
47
48	/**
49	* @return string
50	*/
51	public function getDir() {
52	return $this->dir;
53	}
54
55	/**
56	* @param string $dir
57	* @return $this
58	*/
59	public function setDir($dir) {
60	$this->dir = $dir;
61	return $this;
62	}
63
64	/**
65	* @return string
66	*/
67	public function getLang() {
68	return $this->lang;
69	}
70
71	/**
72	* @param string $lang
73	* @return $this
74	*/
75	public function setLang($lang) {
76	$this->lang = $lang;
77	return $this;
78	}
79
80	/**
81	* @return string
82	*/
83	public function getBody() {
84	return $this->body;
85	}
86
87	/**
88	* @param string $body
89	* @return $this
90	*/
91	public function setBody($body) {
92	$this->body = $body;
93	return $this;
94	}
95
96	/**
97	* @return string
98	*/
99	public function getTag() {
100	return $this->tag;
101	}
102
103	/**
104	* @param string $tag
105	* @return $this
106	*/
107	public function setTag($tag) {
108	$this->tag = $tag;
109	return $this;
110	}
111
112	/**
113	* @return string
114	*/
115	public function getIcon() {
116	return $this->icon;
117	}
118
119	/**
120	* @param string $icon
121	* @return $this
122	*/
123	public function setIcon($icon) {
124	$this->icon = $icon;
125	return $this;
126	}
127
128	/**
129	* @return string
130	*/
131	public function getBadge() {
132	return $this->badge;
133	}
134
135	/**
136	* @param string $badge
137	* @return $this
138	*/
139	public function setBadge($badge) {
140	$this->badge = $badge;
141	return $this;
142	}
143
144	/**
145	* @return string
146	*/
147	public function getImage() {
148	return $this->image;
149	}
150
151	/**
152	* @param string $image
153	* @return $this
154	*/
155	public function setImage($image) {
156	$this->image = $image;
157	return $this;
158	}
159
160	/**
161	* @return string
162	*/
163	public function getSound() {
164	return $this->sound;
165	}
166
167	/**
168	* @param string $sound
169	* @return $this
170	*/
171	public function setSound($sound) {
172	$this->sound = $sound;
173	return $this;
174	}
175
176	/**
177	* @return integer[]
178	*/
179	public function getVibrate() {
180	return $this->vibrate;
181	}
182
183	/**
184	* @param integer[] $vibrate
185	* @return $this
186	*/
187	public function setVibrate($vibrate) {
188	$this->vibrate = $vibrate;
189	return $this;
190	}
191
192	/**
193	* @return integer Timestamp in milliseconds
194	*/
195	public function getTimestamp() {
196	return $this->timestamp;
197	}
198
199	/**
200	* @param integer $timestamp Timestamp in milliseconds
201	* @return $this
202	*/
203	public function setTimestamp($timestamp) {
204	$this->timestamp = $timestamp;
205	return $this;
206	}
207
208	/**
209	* @return boolean
210	*/
211	public function getRenotify() {
212	return $this->renotify;
213	}
214
215	/**
216	* @param boolean $renotify
217	* @return $this
218	*/
219	public function setRenotify($renotify) {
220	$this->renotify = $renotify;
221	return $this;
222	}
223
224	/**
225	* @return boolean
226	*/
227	public function getSilent() {
228	return $this->silent;
229	}
230
231	/**
232	* @param boolean $silent
233	* @return $this
234	*/
235	public function setSilent($silent) {
236	$this->silent = $silent;
237	return $this;
238	}
239
240	/**
241	* @return boolean
242	*/
243	public function getNoscreen() {
244	return $this->noscreen;
245	}
246
247	/**
248	* @param boolean $noscreen
249	* @return $this
250	*/
251	public function setNoscreen($noscreen) {
252	$this->noscreen = $noscreen;
253	return $this;
254	}
255
256	/**
257	* @return boolean
258	*/
259	public function getRequireInteraction() {
260	return $this->requireInteraction;
261	}
262
263	/**
264	* @param boolean $requireInteraction
265	* @return $this
266	*/
267	public function setRequireInteraction($requireInteraction) {
268	$this->requireInteraction = $requireInteraction;
269	return $this;
270	}
271
272	/**
273	* @return boolean
274	*/
275	public function getSticky() {
276	return $this->sticky;
277	}
278
279	/**
280	* @param boolean $sticky
281	* @return $this
282	*/
283	public function setSticky($sticky) {
284	$this->sticky = $sticky;
285	return $this;
286	}
287
288	/**
289	* @return NotificationAlertWebButton[]
290	*/
291	public function getButtons() {
292	return $this->buttons;
293	}
294
295	/**
296	* @param NotificationAlertWebButton[] $buttons
297	* @return $this
298	*/
299	public function setButtons($buttons) {
300	$this->buttons = BaseObject::instantiateForSetter('\WonderPush\Obj\NotificationAlertWebButton[]', $buttons);
301	return $this;
302	}
303
304	}
305