Apply new design of Notification APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.Applications.NotificationEventListener / Tizen.Applications.NotificationEventListener / NotificationEventArgsEnumerations.cs
1 /*
2  * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 namespace Tizen.Applications.NotificationEventListener
18 {
19     using System;
20     using System.ComponentModel;
21
22     /// <summary>
23     /// Enumeration for Progress category
24     /// </summary>
25     public enum ProgressCategory
26     {
27         /// <summary>
28         /// Value for percent type
29         /// </summary>
30         Percent,
31
32         /// <summary>
33         /// Value for time type
34         /// </summary>
35         Time,
36
37         /// <summary>
38         /// Value for pending type which is not updated progress current value
39         /// </summary>
40         PendingBar
41     }
42
43     /// <summary>
44     /// Enumeration for Accessory option
45     /// </summary>
46     public enum AccessoryOption
47     {
48         /// <summary>
49         /// Value for off accessory option
50         /// </summary>
51         Off = -1,
52
53         /// <summary>
54         /// Value for on accessory option
55         /// </summary>
56         On,
57
58         /// <summary>
59         /// Value for custom accessory option
60         /// </summary>
61         Custom
62     }
63
64     /// <summary>
65     /// Enumeration for Button Index
66     /// </summary>
67     public enum ButtonIndex
68     {
69         /// <summary>
70         /// Value for default button index
71         /// </summary>
72         None = -1,
73
74         /// <summary>
75         /// Value for first button index
76         /// </summary>
77         First,
78
79         /// <summary>
80         /// Value for second button index
81         /// </summary>
82         Second,
83
84         /// <summary>
85         /// Value for third button index
86         /// </summary>
87         Third
88     }
89
90     /// <summary>
91     /// Enumeration for notification particular property
92     /// </summary>
93     [Flags]
94     public enum NotificationProperty
95     {
96         /// <summary>
97         /// Value for adjust nothing
98         /// </summary>
99         None = 0x00,
100
101         /// <summary>
102         /// Value for display only SIM card inserted
103         /// </summary>
104         DisplayOnlySimMode = 0x01,
105
106         /// <summary>
107         /// Value for disable application launch when it selected
108         /// </summary>
109         DisableAppLaunch = 0x02,
110
111         /// <summary>
112         /// Value for disable auto delete when it selected
113         /// </summary>
114         DisableAutoDelete = 0x04,
115
116         /// <summary>
117         /// Value for deleted when device is rebooted even though notification is not set OngoingType
118         /// </summary>
119         VolatileDisplay = 0x100,
120     }
121
122     /// <summary>
123     /// Enumeration for event type on notification.
124     /// </summary>
125     [EditorBrowsable(EditorBrowsableState.Never)]
126     public enum UserEventType
127     {
128         /// <summary>
129         /// Event type : Click on button 1
130         /// </summary>
131         ClickOnButton1 = 0,
132
133         /// <summary>
134         /// Event type : Click on button 2
135         /// </summary>
136         ClickOnButton2,
137
138         /// <summary>
139         /// Event type : Click on button 3
140         /// </summary>
141         ClickOnButton3,
142
143         /// <summary>
144         /// Event type : Click on text_input button
145         /// </summary>
146         ClickOnReplyButton = 8,
147
148         /// <summary>
149         /// Event type : Hidden by user
150         /// </summary>
151         HiddenByUser = 100,
152
153         /// <summary>
154         /// Event type : Deleted by timer
155         /// </summary>
156         HiddenByTimeout = 101,
157
158         /// <summary>
159         /// Event type : Clicked by user
160         /// </summary>
161         ClickOnNotification = 200,
162
163         /// <summary>
164         /// Event type : Deleted by user
165         /// </summary>
166         DeleteNotification = 201,
167     }
168
169     /// <summary>
170     /// Enumeration for notification type.
171     /// </summary>
172     internal enum NotificationType
173     {
174         /// <summary>
175         /// Notification type
176         /// </summary>
177         Notification = 0,
178
179         /// <summary>
180         /// Ongoing type
181         /// </summary>
182         Ongoing,
183     }
184
185     /// <summary>
186     /// Enumeration for notification text type.
187     /// </summary>
188     internal enum NotificationText
189     {
190         /// <summary>
191         /// Title
192         /// </summary>
193         Title = 0,
194
195         /// <summary>
196         /// Content
197         /// </summary>
198         Content,
199
200         /// <summary>
201         /// Text to display event count
202         /// </summary>
203         EventCount = 3,
204
205         /// <summary>
206         /// Box contents 1
207         /// </summary>
208         FirstMainText,
209
210         /// <summary>
211         /// Box contents 1-1
212         /// </summary>
213         FirstSubText,
214
215         /// <summary>
216         /// Box contents 2
217         /// </summary>
218         SecondMainText,
219
220         /// <summary>
221         /// Box contents 2-1
222         /// </summary>
223         SecondSubText,
224
225         /// <summary>
226         /// Text on button 1
227         /// </summary>
228         FirstButton = 13,
229
230         /// <summary>
231         /// Text on button 2
232         /// </summary>
233         SecondButton,
234
235         /// <summary>
236         /// Text on button 3
237         /// </summary>
238         ThirdButton,
239
240         /// <summary>
241         /// Guide text on the message reply box
242         /// </summary>
243         PlaceHolder = 19,
244
245         /// <summary>
246         /// Text on button the on message reply box
247         /// </summary>
248         InputButton = 20,
249
250         /// <summary>
251         /// Content for extended notification
252         /// </summary>
253         ContentExtension = 21,
254     }
255
256     /// <summary>
257     /// Enumeration for image type.
258     /// </summary>
259     internal enum NotificationImage
260     {
261         /// <summary>
262         /// Icon
263         /// </summary>
264         Icon = 0,
265
266         /// <summary>
267         /// Indicator icon
268         /// </summary>
269         Indicator,
270
271         /// <summary>
272         ///  Lock screen icon
273         /// </summary>
274         Lockscreen,
275
276         /// <summary>
277         /// Thumbnail
278         /// </summary>
279         Thumbnail,
280
281         /// <summary>
282         /// Lock screen thumbnail
283         /// </summary>
284         ThumbnailLockscreen,
285
286         /// <summary>
287         /// Icon
288         /// </summary>
289         SubIcon,
290
291         /// <summary>
292         /// image displayed on background
293         /// </summary>
294         Background,
295
296         /// <summary>
297         /// Image for button 1
298         /// </summary>
299         Button_1 = 12,
300
301         /// <summary>
302         /// Image for button 2
303         /// </summary>
304         Button_2,
305
306         /// <summary>
307         /// Image for button 3
308         /// </summary>
309         Button_3,
310
311         /// <summary>
312         /// Image for message reply
313         /// </summary>
314         TextInputButton = 18,
315
316         /// <summary>
317         /// Image for extended notification
318         /// </summary>
319         BigPicture = 19,
320     }
321
322     /// <summary>
323     /// Enumeration for notification layout type.
324     /// </summary>
325     internal enum NotificationLayout
326     {
327         /// <summary>
328         /// Default
329         /// </summary>
330         None = 0,
331
332         /// <summary>
333         /// Layout for notification. Used to inform single event
334         /// </summary>
335         SingleEvent = 1,
336
337         /// <summary>
338         /// Layout for notification. Used to display images
339         /// </summary>
340         Thumbnail = 3,
341
342         /// <summary>
343         /// Layout for ongoing notification. Used to display text message
344         /// </summary>
345         OngoingEvent = 4,
346
347         /// <summary>
348         /// Layout for ongoing notification. Used to display progress
349         /// </summary>
350         OngoingProgress = 5,
351
352         /// <summary>
353         /// Layout for extended notification
354         /// </summary>
355         Extension = 6
356     }
357
358     /// <summary>
359     /// Enumeration for notification lauch option type.
360     /// </summary>
361     internal enum LaunchOption
362     {
363         /// <summary>
364         /// Launching with app control
365         /// </summary>
366         AppControl = 1
367     }
368
369     /// <summary>
370     /// Enumeration for notification operation data code.
371     /// </summary>
372     internal enum NotificationOperationDataType
373     {
374         /// <summary>
375         /// Default
376         /// </summary>
377         Min = 0,
378
379         /// <summary>
380         /// Operation type
381         /// </summary>
382         Type,
383
384         /// <summary>
385         /// Private ID
386         /// </summary>
387         UniqueNumber,
388
389         /// <summary>
390         /// Notification handler
391         /// </summary>
392         Notification,
393
394         /// <summary>
395         /// Reserved
396         /// </summary>
397         ExtraInformation1,
398
399         /// <summary>
400         /// Reserved
401         /// </summary>
402         ExtraInformation2,
403     }
404
405     /// <summary>
406     /// Enumeration for notification operation code.
407     /// </summary>
408     internal enum NotificationOperationType
409     {
410         /// <summary>
411         /// Default
412         /// </summary>
413         None = 0,
414
415         /// <summary>
416         /// Notification inserted
417         /// </summary>
418         Insert,
419
420         /// <summary>
421         /// Notification updated
422         /// </summary>
423         Update,
424
425         /// <summary>
426         /// Notification deleted
427         /// </summary>
428         Delete,
429     }
430
431     /// <summary>
432     /// Enumeration for event type on notification.
433     /// </summary>
434     internal enum ClickEventType
435     {
436         /// <summary>
437         /// Event type : Click on button 1
438         /// </summary>
439         FirstButton = 0,
440
441         /// <summary>
442         /// Event type : Click on button 2
443         /// </summary>
444         SecondButton = 1,
445
446         /// <summary>
447         /// Event type : Click on button 3
448         /// </summary>
449         ThirdButton = 2,
450
451         /// <summary>
452         /// Event type : Click on icon
453         /// </summary>
454         Icon = 6,
455
456         /// <summary>
457         /// Event type : Click on thumbnail
458         /// </summary>
459         Thumbnail = 7,
460
461         /// <summary>
462         /// Event type : Click on text_input button
463         /// </summary>
464         InputButton = 8,
465     }
466
467     /// <summary>
468     /// Enumeration for display application list.
469     /// </summary>
470     [Flags]
471     internal enum NotificatioDisplayApplist
472     {
473         /// <summary>
474         /// Notification Tray(Quickpanel)
475         /// </summary>
476         Tray = 0x00000001,
477
478         /// <summary>
479         /// Ticker notification
480         /// </summary>
481         Ticker = 0x00000002,
482
483         /// <summary>
484         /// Lock screen
485         /// </summary>
486         Lock = 0x00000004,
487
488         /// <summary>
489         /// Indicator
490         /// </summary>
491         Indicator = 0x00000008,
492
493         /// <summary>
494         /// Active notification
495         /// </summary>
496         Active = 0x00000010,
497
498         /// <summary>
499         /// All display application except active notification
500         /// </summary>
501         All = 0x0000000f,
502     }
503 }