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

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

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

NotificationAlertIosAttachment.php

128 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.ios.attachments` items.
9	* @see NotificationAlertIos
10	* @codeCoverageIgnore
11	*/
12	class NotificationAlertIosAttachment extends BaseObject {
13
14	/** @var string */
15	protected $id;
16	/**
17	* @var string
18	* Audio files should not be over 5 MB.
19	* Image files should not be over 10 MB.
20	* Video files should not be over 50 MB.
21	*/
22	protected $url;
23	/**
24	* @var string
25	* Derived from the url file-extension by iOS itself if not given.
26	* The SDK understands the following shortcuts, and raw values, described in `options`.
27	* Images:
28	* png,jpg,jpeg,gif,
29	* image/png,image/x-png,image/jpeg,image/gif,
30	* Audio:
31	* wav,wave,aiff,mp3,m4a,mp4a,
32	* audio/wav,audio/x-wav,audio/aiff,audio/x-aiff,audio/mpeg,audio/mp3,audio/mpeg3,audio/mp4,
33	* Video:
34	* mpg,mpeg,mp2,m2v,mp4,avi,
35	* video/mpeg,video/x-mpeg1,video/mpeg2,video/x-mpeg2,video/mp4,video/mpeg4,video/avi
36	*/
37	protected $type;
38	/**
39	* @var array
40	* https://trello.com/c/QERhnU9Y/987-ios-10-rich-notifications-memento
41	* https://developer.apple.com/reference/usernotifications/unnotificationattachment/attachment_attributes
42	* typeHint: "a UNNotificationAttachmentOptionsTypeHintKey value constant",
43	* kUTTypeAudioInterchangeFileFormat = "public.aiff-audio"
44	* kUTTypeWaveformAudio = "com.microsoft.waveform-audio"
45	* kUTTypeMP3 = "public.mp3"
46	* kUTTypeMPEG4Audio = "public.mpeg-4-audio"
47	* kUTTypeJPEG = "public.jpeg"
48	* kUTTypeGIF = "com.compuserve.gif"
49	* kUTTypePNG = "public.png"
50	* kUTTypeMPEG = "public.mpeg"
51	* kUTTypeMPEG2Video = "public.mpeg-2-video"
52	* kUTTypeMPEG4 = "public.mpeg-4"
53	* kUTTypeAVIMovie = "public.avi"
54	* thumbnailHidden: false,
55	* thumbnailClippingRect: {"X":0.0, "Y":0.0, "Width":1.0, "Height":1.0},
56	* thumbnailTime: a UNNotificationAttachmentOptionsThumbnailTimeKey value
57	* Frame number [0;N-1], don't go outside the range
58	* Time in seconds for movies (not for gifs)
59	* {value,timescale,epoch:0,flags=1} (not for gifs) (eg: value=241, timescale=24 is 10 seconds plus one frame)
60	*/
61	protected $options;
62
63	/**
64	* @return string
65	*/
66	public function getId() {
67	return $this->id;
68	}
69
70	/**
71	* @param string $id
72	* @return NotificationAlertIosAttachment
73	*/
74	public function setId($id) {
75	$this->id = $id;
76	return $this;
77	}
78
79	/**
80	* @return string
81	*/
82	public function getUrl() {
83	return $this->url;
84	}
85
86	/**
87	* @param string $url
88	* @return NotificationAlertIosAttachment
89	*/
90	public function setUrl($url) {
91	$this->url = $url;
92	return $this;
93	}
94
95	/**
96	* @return string
97	*/
98	public function getType() {
99	return $this->type;
100	}
101
102	/**
103	* @param string $type
104	* @return NotificationAlertIosAttachment
105	*/
106	public function setType($type) {
107	$this->type = $type;
108	return $this;
109	}
110
111	/**
112	* @return array
113	*/
114	public function getOptions() {
115	return $this->options;
116	}
117
118	/**
119	* @param array $options
120	* @return NotificationAlertIosAttachment
121	*/
122	public function setOptions($options) {
123	$this->options = $options;
124	return $this;
125	}
126
127	}
128