Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.Notification.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Applications.Notification</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Tizen.Applications.Notifications.Notification">\r
8             <summary>\r
9             This class contains common properties and methods of notifications.\r
10             </summary>\r
11             <remarks>\r
12             A notification is a message that is displayed on the notification area.\r
13             It is created to notify information to the user through the application.\r
14             This class helps you to provide method and property for creating notification object.\r
15             </remarks>\r
16             <summary>\r
17             This class contains common properties and methods of notifications.\r
18             </summary>\r
19             <remarks>\r
20             A notification is a message that is displayed on the notification area.\r
21             It is created to notify information to the user through the application.\r
22             This class helps you to provide method and property for creating notification object.\r
23             </remarks>\r
24             <summary>\r
25             This class contains common properties and methods of notifications.\r
26             </summary>\r
27             <remarks>\r
28             A notification is a message that is displayed on the notification area.\r
29             It is created to notify information to the user through the application.\r
30             This class helps you to provide method and property for creating notification object.\r
31             </remarks>\r
32             <summary>\r
33             This class contains common properties and methods of notifications.\r
34             </summary>\r
35             <remarks>\r
36             A notification is a message that is displayed on the notification area.\r
37             It is created to notify information to the user through the application.\r
38             This class helps you to provide method and property for creating notification object.\r
39             </remarks>\r
40             <summary>\r
41             The class contains common properties and methods of notifications.\r
42             </summary>\r
43             <remarks>\r
44             A notification is a message that is displayed on the notification area.\r
45             It is created to notify information to the user through the application.\r
46             This class helps you to provide method and property for creating notification object.\r
47             </remarks>\r
48             <summary>\r
49             This class contains common properties and methods of notifications.\r
50             </summary>\r
51             <remarks>\r
52             A notification is a message that is displayed on the notification area.\r
53             It is created to notify information to the user through the application.\r
54             This class helps you to provide method and property for creating notification object.\r
55             </remarks>\r
56             <summary>\r
57             This class contains common properties and methods of notifications.\r
58             </summary>\r
59             <remarks>\r
60             A notification is a message that is displayed on the notification area.\r
61             It is created to notify information to the user through the application.\r
62             This class helps you to provide method and property for creating notification object.\r
63             </remarks>\r
64             <summary>\r
65             This class contains common properties and methods of notifications.\r
66             </summary>\r
67             <remarks>\r
68             A notification is a message that is displayed on the notification area.\r
69             It is created to notify information to the user through the application.\r
70             This class helps you to provide method and property for creating notification object.\r
71             </remarks>\r
72             <summary>\r
73             This class contains common properties and methods of notifications.\r
74             </summary>\r
75             <remarks>\r
76             A notification is a message that is displayed on the notification area.\r
77             It is created to notify information to the user through the application.\r
78             This class helps you to provide method and property for creating notification object.\r
79             </remarks>\r
80             <summary>\r
81             This class contains common properties and methods of notifications.\r
82             </summary>\r
83             <remarks>\r
84             A notification is a message that is displayed on the notification area.\r
85             It is created to notify information to the user through the application.\r
86             This class helps you to provide method and property for creating notification object.\r
87             </remarks>\r
88         </member>\r
89         <member name="M:Tizen.Applications.Notifications.Notification.#ctor">\r
90             <summary>\r
91             Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification"/> class.\r
92             </summary>\r
93         </member>\r
94         <member name="P:Tizen.Applications.Notifications.Notification.Tag">\r
95             <summary>\r
96             Gets or sets the tag of notification.\r
97             </summary>\r
98         </member>\r
99         <member name="P:Tizen.Applications.Notifications.Notification.Title">\r
100             <summary>\r
101             Gets or sets the title of notification.\r
102             </summary>\r
103         </member>\r
104         <member name="P:Tizen.Applications.Notifications.Notification.Icon">\r
105             <summary>\r
106             Gets or sets the icon of notification.\r
107             You should set an absolute path for an image file.\r
108             </summary>\r
109         </member>\r
110         <member name="P:Tizen.Applications.Notifications.Notification.SubIcon">\r
111             <summary>\r
112             Gets or sets the sub icon of notification.\r
113             This SubIcon is displayed in Icon you set.\r
114             You should set an absolute path for an image file.\r
115             </summary>\r
116         </member>\r
117         <member name="P:Tizen.Applications.Notifications.Notification.Content">\r
118             <summary>\r
119             Gets or sets the content of notification.\r
120             </summary>\r
121         </member>\r
122         <member name="P:Tizen.Applications.Notifications.Notification.IsTimeStampVisible">\r
123             <summary>\r
124             Gets or sets a value indicating whether TimeStamp of the notification is Visible or not.\r
125             Default to true.\r
126             </summary>\r
127         </member>\r
128         <member name="P:Tizen.Applications.Notifications.Notification.TimeStamp">\r
129             <summary>\r
130             Gets or sets the TimeStamp of notification.\r
131             </summary>\r
132             <remarks>\r
133             If you don't set TimeStamp, it will set the value when the notification is posted.\r
134             TimeStamp requires NotificationManager.Post() to be called.\r
135             If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification.\r
136             </remarks>\r
137         </member>\r
138         <member name="P:Tizen.Applications.Notifications.Notification.Action">\r
139             <summary>\r
140             Gets or sets action, which is invoked when the notification is clicked.\r
141             </summary>\r
142             <remarks>\r
143             If you set it to null, the already set AppControl will be removed and nothing will happen when you click on notification.\r
144             </remarks>\r
145             <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
146         </member>\r
147         <member name="P:Tizen.Applications.Notifications.Notification.Count">\r
148             <summary>\r
149             Gets or sets count, which is displayed at the right side of the notification.\r
150             </summary>\r
151             <remarks>\r
152             You must set only positive number.\r
153             If you set count to negative number, this property throws exception.\r
154             </remarks>\r
155             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
156         </member>\r
157         <member name="P:Tizen.Applications.Notifications.Notification.Property">\r
158             <summary>\r
159             Gets or sets property.\r
160             </summary>\r
161             <seealso cref="T:Tizen.Applications.Notifications.NotificationProperty"></seealso>\r
162         </member>\r
163         <member name="P:Tizen.Applications.Notifications.Notification.Progress">\r
164             <summary>\r
165             Gets or sets <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> object for display at notification.\r
166             </summary>\r
167             <seealso cref="T:Tizen.Applications.Notifications.Notification.ProgressType"></seealso>\r
168         </member>\r
169         <member name="P:Tizen.Applications.Notifications.Notification.Accessory">\r
170              <summary>\r
171              Gets or sets <see cref="T:Tizen.Applications.Notifications.Notification.AccessorySet"/> which is included vibration, LED and sound option to be applied at notification.\r
172              </summary>\r
173              <remarks>\r
174              If you set it to null, the already set AccessorySet will be initialized.\r
175              </remarks>\r
176              <example>\r
177              <code>\r
178              Notification notification = new Notification\r
179              {\r
180                  Title = "Notification",\r
181                  Content = "Hello Tizen",\r
182                  Icon = "Icon path",\r
183                  Count = 3\r
184              };\r
185             \r
186              Notification.AccessorySet accessory = new Notification.AccessorySet\r
187              {\r
188                  SoundOption = AccessoryOption.Custom,\r
189                  SoundPath = "Sound File Path",\r
190                  IsVibration = true,\r
191                  LedOption = AccessoryOption.Custom,\r
192                  LedOnMs = 100;\r
193                  LedOffMs = 50;\r
194                  LedColor = Color.Lime\r
195              };\r
196             \r
197              notification.Accessory = accessory;\r
198             \r
199              NotificationManager.Post(notification);\r
200              </code>\r
201              </example>\r
202         </member>\r
203         <member name="P:Tizen.Applications.Notifications.Notification.IsVisible">\r
204             <summary>\r
205             Gets or sets a value indicating whether notification is displayed on the default viewer.\r
206             If you set false and add style, you can see only style notification.\r
207             </summary>\r
208         </member>\r
209         <member name="P:Tizen.Applications.Notifications.Notification.Handle">\r
210             <summary>\r
211             Gets or sets NotificationSafeHandle.\r
212             </summary>\r
213         </member>\r
214         <member name="P:Tizen.Applications.Notifications.Notification.PrivID">\r
215             <summary>\r
216             Gets or sets private ID.\r
217             </summary>\r
218         </member>\r
219         <member name="M:Tizen.Applications.Notifications.Notification.AddStyle(Tizen.Applications.Notifications.Notification.StyleBase)">\r
220              <summary>\r
221              Method for adding various styles to be applied to notification.\r
222              </summary>\r
223              <remarks>\r
224              The user always see about valid notification style. If you add a style which is not supported in platform,\r
225              this method has no effect.\r
226              </remarks>\r
227              <param name="style">The style to be applied to notification.</param>\r
228              <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
229              <example>\r
230              <code>\r
231              Notification notification = new Notification\r
232              {\r
233                  Title = "Notification",\r
234                  Content = "Hello Tizen",\r
235                  Icon = "Icon path",\r
236                  Count = 3\r
237              };\r
238             \r
239              Notification.LockStyle lockStyle = new Notification.LockStyle\r
240              {\r
241                  IconPath = "Icon path",\r
242                  ThumbnailPath = "Thumbnail Path"\r
243              };\r
244             \r
245              notification.AddStyle(lockStyle);\r
246             \r
247              NotificationManager.Post(notification);\r
248              </code>\r
249              </example>\r
250         </member>\r
251         <member name="M:Tizen.Applications.Notifications.Notification.RemoveStyle``1">\r
252             <summary>\r
253             Method to remove style you already added.\r
254             </summary>\r
255             <typeparam name="T">Type of notification style to be queried.</typeparam>\r
256             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
257         </member>\r
258         <member name="M:Tizen.Applications.Notifications.Notification.GetStyle``1">\r
259             <summary>\r
260             Method to get style you already added.\r
261             </summary>\r
262             <typeparam name="T">Type of notification style to be queried.</typeparam>\r
263             <returns>\r
264             The Notification.Style object associated with the given style.\r
265             </returns>\r
266             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
267         </member>\r
268         <member name="M:Tizen.Applications.Notifications.Notification.SetExtraData(System.String,Tizen.Applications.Bundle)">\r
269              <summary>\r
270              Method to set extra data to add extra data.\r
271              </summary>\r
272              <remarks>\r
273              The type of extra data is bundle.\r
274              </remarks>\r
275              <param name="key">The key of the extra data you want to add.</param>\r
276              <param name="value">The value you want to add.</param>\r
277              <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
278              <example>\r
279              <code>\r
280              Notification notification = new Notification\r
281              {\r
282                  Title = "Notification",\r
283                  Content = "Hello Tizen",\r
284                  Icon = "Icon path",\r
285              };\r
286             \r
287              Bundle bundle = new Bundle();\r
288              bundle.AddItem("key", "value");\r
289             \r
290              notification.SetExtraData("firstKey", bundle);\r
291              </code>\r
292              </example>\r
293         </member>\r
294         <member name="M:Tizen.Applications.Notifications.Notification.RemoveExtraData(System.String)">\r
295             <summary>\r
296             Method to remove extra you already added.\r
297             </summary>\r
298             <remarks>\r
299             The type of extra data is bundle.\r
300             </remarks>\r
301             <param name="key">The key of the extra data to add.</param>\r
302             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
303         </member>\r
304         <member name="M:Tizen.Applications.Notifications.Notification.GetExtraData(System.String)">\r
305             <summary>\r
306             Method to get extra data you already set.\r
307             </summary>\r
308             <param name="key">The key of the extra data to get.</param>\r
309             <returns>Bundle Object that include extra data</returns>\r
310             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
311         </member>\r
312         <member name="M:Tizen.Applications.Notifications.Notification.Dispose">\r
313             <summary>\r
314             Releases any unmanaged resources used by this object.\r
315             </summary>\r
316         </member>\r
317         <member name="T:Tizen.Applications.Notifications.Notification.AccessorySet">\r
318             <summary>\r
319              Class for notification AccessorySet, which includes vibration, LED, and sound option.\r
320             </summary>\r
321         </member>\r
322         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundOption">\r
323             <summary>\r
324             Gets or sets the sound option. Default to AccessoryOption.Off.\r
325             </summary>\r
326             <remarks>\r
327             If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown.\r
328             </remarks>\r
329         </member>\r
330         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundPath">\r
331             <summary>\r
332             Gets or sets the sound path, It will play on the sound file you set.\r
333             You should set an absolute path for a sound file.\r
334             </summary>\r
335         </member>\r
336         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.CanVibrate">\r
337             <summary>\r
338             Gets or sets a value indicating whether vibration is operated. Default is false.\r
339             </summary>\r
340         </member>\r
341         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOption">\r
342             <summary>\r
343             Gets or sets the led option. The default value is AccessoryOption.Off.\r
344             </summary>\r
345             <remarks>\r
346             If you set AccessoryOption.Custom and not set LedColor, the LED will show default color.\r
347             </remarks>\r
348         </member>\r
349         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOnMillisecond">\r
350             <summary>\r
351             Gets or sets the on time so that it looks like the device's LED is blinking.\r
352             </summary>\r
353             <remarks>\r
354             Default value of LedOnMillisecond is 0.\r
355             The rate is specified in terms of the number of Milliseconds to be on.\r
356             You must set the on and off times at the same time. Otherwise, it may not operate normally.\r
357             </remarks>\r
358         </member>\r
359         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOffMillisecond">\r
360             <summary>\r
361             Gets or sets the off time so that it looks like the device's LED is blinking.\r
362             </summary>\r
363             <remarks>\r
364             The rate is specified in terms of the number of Milliseconds to be off.\r
365             You must set the on and off times at the same time. Otherwise, it may not operate normally.\r
366             </remarks>\r
367         </member>\r
368         <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedColor">\r
369             <summary>\r
370             Gets or sets the LED color that you would like the LED on the device to blink.\r
371             </summary>\r
372             <remarks>\r
373             If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color.\r
374             </remarks>\r
375         </member>\r
376         <member name="T:Tizen.Applications.Notifications.Notification.ActiveStyle">\r
377             <summary>\r
378              Class for generating active style notification.\r
379             </summary>\r
380         </member>\r
381         <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.#ctor">\r
382             <summary>\r
383             Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ActiveStyle"/> class.\r
384             </summary>\r
385         </member>\r
386         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.BackgroundImage">\r
387             <summary>\r
388             Gets or sets an absolute path for an image file to display on the background of active notification.\r
389             </summary>\r
390         </member>\r
391         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.IsAutoRemove">\r
392             <summary>\r
393             Gets or sets a value indicating whether the active notification is removed automatically. Default value is true.\r
394             </summary>\r
395             <remarks>\r
396             IsAutoRemove option lets the active notification to be removed several seconds after it shows.\r
397             When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes\r
398             it or the application, which posted the active notification.\r
399             </remarks>>\r
400         </member>\r
401         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.DefaultButton">\r
402             <summary>\r
403             Gets or sets the default button to display highlight on the active notification.\r
404             </summary>\r
405             <remarks>\r
406             The default button for display highlight is only reflected on the Tizen TV.\r
407             If you use this property on other profile, this value has no effect.\r
408             </remarks>\r
409         </member>\r
410         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.ReplyAction">\r
411              <summary>\r
412              Gets or sets a ReplyAction to this active notification style.\r
413              </summary>\r
414              <remarks>\r
415              When you add a ReplyAction to the ActiveStyle, the notification UI will show a ReplyAction with button.\r
416              If you set null parameter, ReplyAction is not displayed.\r
417              </remarks>\r
418              <example>\r
419              <code>\r
420             \r
421              ButtonAction button = new ButtonAction\r
422              {\r
423                  Index = ButtonIndex.First,\r
424                  Text = "Yes"\r
425                  Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
426              };\r
427             \r
428              ReplyAction reply = new ReplyAction\r
429              {\r
430                  ParentIndex = ButtonIndex.First;\r
431                  PlaceHolderText = "Please write your reply."\r
432                  ReplyMax = 160,\r
433                  Button = new ButtonAction\r
434                  {\r
435                      Text = "Yes",\r
436                      ImagePath = "image path"\r
437                      Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
438                  };\r
439              };\r
440             \r
441              ActiveStyle active = new ActiveStyle\r
442              {\r
443                  AutoRemove = true,\r
444                  BackgroundImage = "image path",\r
445                  ReplyAction = reply\r
446              };\r
447             \r
448              active.AddButtonAction(button);\r
449              </code>\r
450              </example>\r
451         </member>\r
452         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByUserAction">\r
453             <summary>\r
454             Gets or sets Action which is invoked when notification is hidden by user.\r
455             </summary>\r
456             <remarks>\r
457             If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by user.\r
458             The property is only reflected on Tizen TV.\r
459             If you use this API on other profile, this action have no effect\r
460             </remarks>\r
461             <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
462         </member>\r
463         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByTimeoutAction">\r
464             <summary>\r
465             Gets or sets Action which is invoked when there is no any response by user until hide timeout.\r
466             </summary>\r
467             <remarks>\r
468             This action occurs when there is no response to the notification until the delete timeout set by SetRemoveTime().\r
469             If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by timeout.\r
470             The property is only reflected on Tizen TV.\r
471             If you use this API on other profile, this action settings have no effect\r
472             </remarks>\r
473             <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
474         </member>\r
475         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByExternalAction">\r
476             <summary>\r
477             Gets or sets Action which is invoked when the notification is hidden by external factor.\r
478             </summary>\r
479             <remarks>\r
480             If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by external factor.\r
481             The property is only reflected on Tizen TV.\r
482             If you use this API on other profile, this action settings have no effect\r
483             </remarks>\r
484             <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
485         </member>\r
486         <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.Key">\r
487             <summary>\r
488             Gets the key of ActiveStyle.\r
489             </summary>\r
490         </member>\r
491         <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.SetRemoveTime(System.Int32,System.Int32)">\r
492             <summary>\r
493             Method to set time to hide or delete notification.\r
494             </summary>\r
495             <remarks>\r
496             The time settings for hiding and deleting are only reflected on the Tizen TV.\r
497             If you use this API on other profile, this time settings have no effect.\r
498             </remarks>\r
499             <param name="hideTime">The value in seconds when the notification can be hidden from the notification viewer after the notification is posted.</param>\r
500             <param name="deleteTime">The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted.</param>\r
501             <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>\r
502         </member>\r
503         <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetRemoveTime(System.Int32@,System.Int32@)">\r
504             <summary>\r
505             Method to get time set to hide or delete notification.\r
506             </summary>\r
507             <param name="hideTime">The value in seconds when the notification can be hidden from the notification viewer after notification is posted.</param>\r
508             <param name="deleteTime">The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted.</param>\r
509         </member>\r
510         <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.AddButtonAction(Tizen.Applications.Notifications.Notification.ButtonAction)">\r
511              <summary>\r
512              Method to add a button to the active notification style.\r
513              Buttons are displayed on the notification.\r
514              </summary>\r
515              <remarks>\r
516              If you add button that has same index, the button is replaced to latest adding button.\r
517              If you don't set an index on ButtonAction, the index is set sequentially from zero.\r
518              </remarks>\r
519              <param name="button">A ButtonAction for appear to the notification.</param>\r
520              <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>\r
521              <example>\r
522              <code>\r
523             \r
524              ButtonAction button = new ButtonAction\r
525              {\r
526                  Index = 0,\r
527                  Text = "Yes"\r
528                  Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
529              };\r
530             \r
531              ActiveStyle active = new ActiveStyle\r
532              {\r
533                  IsAutoRemove = true,\r
534                  BackgroundImage = "image path",\r
535              };\r
536             \r
537              active.AddButtonAction(button);\r
538             \r
539              </code>\r
540              </example>\r
541         </member>\r
542         <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.RemoveButtonAction(Tizen.Applications.Notifications.ButtonIndex)">\r
543             <summary>\r
544             Removes the ButtonAction you already added.\r
545             </summary>\r
546             <param name="index">The index to remove a button.</param>\r
547             <returns>true if the element is successfully found and removed; otherwise, false.</returns>\r
548         </member>\r
549         <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetButtonAction(Tizen.Applications.Notifications.ButtonIndex)">\r
550             <summary>\r
551             Gets the ButtonAction of the active notification.\r
552             </summary>\r
553             <param name="index">The index to get a button you already added.</param>\r
554             <returns>The ButtonAction object, which you already added.</returns>\r
555             <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>\r
556         </member>\r
557         <member name="T:Tizen.Applications.Notifications.Notification.ButtonAction">\r
558             <summary>\r
559             This class helps you to set the button on active style of notification.\r
560             </summary>\r
561             <remarks>\r
562             It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button.\r
563             </remarks>>\r
564         </member>\r
565         <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Index">\r
566             <summary>\r
567             Gets or sets the index of the button, which appeares as notification.\r
568             </summary>\r
569         </member>\r
570         <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Text">\r
571             <summary>\r
572             Gets or sets the text describing the button.\r
573             </summary>\r
574         </member>\r
575         <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.ImagePath">\r
576             <summary>\r
577             Gets or sets the image path that represents the button.\r
578             You should provide an absolute path for an image file.\r
579             </summary>\r
580         </member>\r
581         <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Action">\r
582             <summary>\r
583             Gets or sets the action, which is invoked when the button is clicked.\r
584             </summary>\r
585             <value>\r
586             If you don't set action, nothing happens when the button is clicked.\r
587             </value>\r
588             <example>\r
589             <code>\r
590             ButtonAction button = new ButtonAction\r
591             {\r
592                 Index = ButtonIndex.First,\r
593                 text = "Yes",\r
594                 ImagePath = "image path",\r
595                 Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
596             };\r
597             </code>\r
598             </example>\r
599             <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
600         </member>\r
601         <member name="T:Tizen.Applications.Notifications.Notification.IndicatorStyle">\r
602             <summary>\r
603              Class for generating indicator style notification.\r
604             </summary>\r
605         </member>\r
606         <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.IconPath">\r
607             <summary>\r
608             Gets or sets an absolute path for an image file.\r
609             If you set IconPath, you can see the icon on the right side of indicator.\r
610             </summary>\r
611         </member>\r
612         <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.SubText">\r
613             <summary>\r
614             Gets or sets a sub text for displaying indicator style.\r
615             </summary>\r
616         </member>\r
617         <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.Key">\r
618             <summary>\r
619             Gets the key of IndicatorStyle.\r
620             </summary>\r
621         </member>\r
622         <member name="T:Tizen.Applications.Notifications.Notification.LockStyle">\r
623             <summary>\r
624             Class for generating lock style notification.\r
625             </summary>\r
626         </member>\r
627         <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.IconPath">\r
628             <summary>\r
629             Gets or sets an absolute path for an image file to display the icon of lock style.\r
630             </summary>\r
631         </member>\r
632         <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.ThumbnailPath">\r
633             <summary>\r
634             Gets or sets an absolute path for a thumbnail image file to display on lock style.\r
635             </summary>\r
636         </member>\r
637         <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.Key">\r
638             <summary>\r
639             Gets the key of LockStyle.\r
640             </summary>\r
641         </member>\r
642         <member name="T:Tizen.Applications.Notifications.Notification.MakerBase">\r
643             <summary>\r
644             An object that helps notification to make to SafeHandle.\r
645             </summary>\r
646         </member>\r
647         <member name="T:Tizen.Applications.Notifications.Notification.ProgressType">\r
648             <summary>\r
649              Class for displaying progress notification.\r
650              You must initialize progress category, current, and max value when you create an object.\r
651             </summary>\r
652         </member>\r
653         <member name="M:Tizen.Applications.Notifications.Notification.ProgressType.#ctor(Tizen.Applications.Notifications.ProgressCategory,System.Double,System.Double)">\r
654             <summary>\r
655             Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> class.\r
656             You must initialize category, current, and max value of the progress.\r
657             </summary>\r
658             <param name="category">The category of progress that appeared on notification.</param>\r
659             <param name="current">The current value of the progress.</param>\r
660             <param name="max">The max value of the progress.</param>\r
661             <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>\r
662         </member>\r
663         <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.Category">\r
664             <summary>\r
665             Gets or sets category of ProgressType.\r
666             </summary>\r
667             <seealso cref="T:Tizen.Applications.Notifications.ProgressCategory"></seealso>\r
668         </member>\r
669         <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressCurrent">\r
670             <summary>\r
671             Gets or sets current value of ProgressType.\r
672             </summary>\r
673             <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>\r
674         </member>\r
675         <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressMax">\r
676             <summary>\r
677             Gets or sets max value of ProgressType.\r
678             </summary>\r
679             <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>\r
680         </member>\r
681         <member name="T:Tizen.Applications.Notifications.Notification.ReplyAction">\r
682             <summary>\r
683              Class for displaying direct-reply on notification.\r
684              You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl.\r
685             </summary>\r
686         </member>\r
687         <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ParentIndex">\r
688             <summary>\r
689             Gets or sets the index of button, which appears at notification.\r
690             If you set ParentIndex, ReplyAction is displayed when button matches with ParentIndex that is clicked by the user.\r
691             If you don't set ParentIndex, it appears as notification directly.\r
692             </summary>\r
693         </member>\r
694         <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.PlaceHolderText">\r
695             <summary>\r
696             Gets or sets the PlaceHolderText of ReplyAction which appears at notification.\r
697             If you set PlaceHolderText, it is displayed to placeholder in notification.\r
698             </summary>\r
699         </member>\r
700         <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ReplyMax">\r
701             <summary>\r
702             Gets or sets the maximum number of characters that the user can input.\r
703             You must set a ReplyMax. Otherwise user don't write text to placeholder in notification.\r
704             </summary>\r
705             <value>\r
706             Default value is 160.\r
707             </value>\r
708         </member>\r
709         <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.Button">\r
710             <summary>\r
711             Gets or sets the button, which appears as ReplyAction in notification.\r
712             You must set the button, otherwise, a user can't send written text to application, which is set by AppControl.\r
713             </summary>\r
714             <remarks>\r
715             If you set it to null, the already set ButtonAction will be removed.\r
716             </remarks>\r
717             <example>\r
718             <code>\r
719             ReplyAction button = new ReplyAction\r
720             {\r
721                 ParentIndex = ButtonIndex.Second;\r
722                 PlaceHolderText = "Please write your reply."\r
723                 ReplyMax = 160,\r
724                 Button = new ButtonAction\r
725                 {\r
726                     text = "Yes",\r
727                     ImagePath = "image path",\r
728                     Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
729                 };\r
730             };\r
731             </code>\r
732             </example>\r
733         </member>\r
734         <member name="T:Tizen.Applications.Notifications.Notification.StyleBase">\r
735             <summary>\r
736             An object can apply a rich notification style to a notification object.\r
737             If the platform does not provide rich notification, styles in this class have no effect.\r
738             </summary>\r
739         </member>\r
740         <member name="T:Tizen.Applications.Notifications.ProgressCategory">\r
741             <summary>\r
742             Enumeration for the progress category.\r
743             </summary>\r
744         </member>\r
745         <member name="F:Tizen.Applications.Notifications.ProgressCategory.Percent">\r
746             <summary>\r
747             Value for percent type.\r
748             </summary>\r
749         </member>\r
750         <member name="F:Tizen.Applications.Notifications.ProgressCategory.Time">\r
751             <summary>\r
752             Value for time type.\r
753             </summary>\r
754         </member>\r
755         <member name="F:Tizen.Applications.Notifications.ProgressCategory.PendingBar">\r
756             <summary>\r
757             Value for pending type, which is not the updated progress current value.\r
758             </summary>\r
759         </member>\r
760         <member name="T:Tizen.Applications.Notifications.AccessoryOption">\r
761             <summary>\r
762             Enumeration for the accessory option.\r
763             </summary>\r
764         </member>\r
765         <member name="F:Tizen.Applications.Notifications.AccessoryOption.Off">\r
766             <summary>\r
767             Value for off accessory option.\r
768             </summary>\r
769         </member>\r
770         <member name="F:Tizen.Applications.Notifications.AccessoryOption.On">\r
771             <summary>\r
772             Value for on accessory option.\r
773             </summary>\r
774         </member>\r
775         <member name="F:Tizen.Applications.Notifications.AccessoryOption.Custom">\r
776             <summary>\r
777             Value for the custom accessory option.\r
778             </summary>\r
779         </member>\r
780         <member name="T:Tizen.Applications.Notifications.ButtonIndex">\r
781             <summary>\r
782             Enumeration for the button index.\r
783             </summary>\r
784         </member>\r
785         <member name="F:Tizen.Applications.Notifications.ButtonIndex.None">\r
786             <summary>\r
787             Value for the default button index.\r
788             </summary>\r
789         </member>\r
790         <member name="F:Tizen.Applications.Notifications.ButtonIndex.First">\r
791             <summary>\r
792             Value for the first button index.\r
793             </summary>\r
794         </member>\r
795         <member name="F:Tizen.Applications.Notifications.ButtonIndex.Second">\r
796             <summary>\r
797             Value for the second button index.\r
798             </summary>\r
799         </member>\r
800         <member name="F:Tizen.Applications.Notifications.ButtonIndex.Third">\r
801             <summary>\r
802             Value for the third button index.\r
803             </summary>\r
804         </member>\r
805         <member name="T:Tizen.Applications.Notifications.NotificationProperty">\r
806             <summary>\r
807             Enumeration for the notification particular property.\r
808             </summary>\r
809         </member>\r
810         <member name="F:Tizen.Applications.Notifications.NotificationProperty.None">\r
811             <summary>\r
812             Value for adjust nothing.\r
813             </summary>\r
814         </member>\r
815         <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisplayOnlySimMode">\r
816             <summary>\r
817             Value for display only SIM card inserted.\r
818             </summary>\r
819         </member>\r
820         <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAppLaunch">\r
821             <summary>\r
822             Value for disable application launch when it is selected.\r
823             </summary>\r
824         </member>\r
825         <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAutoDelete">\r
826             <summary>\r
827             Value for disable auto delete when it is selected.\r
828             </summary>\r
829         </member>\r
830         <member name="F:Tizen.Applications.Notifications.NotificationProperty.VolatileDisplay">\r
831             <summary>\r
832             Value for deleted when device is rebooted even though notification is not set ongoing.\r
833             </summary>\r
834         </member>\r
835         <member name="T:Tizen.Applications.Notifications.NotificationBlockState">\r
836             <summary>\r
837             Enumeration for the block state.\r
838             </summary>\r
839         </member>\r
840         <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Allowed">\r
841             <summary>\r
842             Value to check if the app is allowed to post notification.\r
843             </summary>\r
844         </member>\r
845         <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Blocked">\r
846             <summary>\r
847             Value to check if the app is not allowed to post any notification.\r
848             </summary>\r
849         </member>\r
850         <member name="F:Tizen.Applications.Notifications.NotificationBlockState.DoNotDisturb">\r
851             <summary>\r
852             Value to check if the do not disturb mode is set by the user.\r
853             </summary>\r
854         </member>\r
855         <member name="T:Tizen.Applications.Notifications.NotificationManager">\r
856             <summary>\r
857             NotificationManager class to post, update, delete, and get notification.\r
858             </summary>\r
859         </member>\r
860         <member name="M:Tizen.Applications.Notifications.NotificationManager.Post(Tizen.Applications.Notifications.Notification)">\r
861              <summary>\r
862              Posts a new notification.\r
863              </summary>\r
864              <param name="notification">Notification to post.</param>\r
865              <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
866              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
867              <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
868              <example>\r
869              <code>\r
870              Notification notification = new Notification\r
871              {\r
872                  Title = "title",\r
873                  Content = "content",\r
874                  Icon = "absolute icon path",\r
875                  Tag = "first notification"\r
876              };\r
877             \r
878              Notification.AccessorySet accessory = new Notification.AccessorySet\r
879              {\r
880                  SoundOption = AccessoryOption.On,\r
881                  CanVibrate = true\r
882              };\r
883              notification.Accessory = accessory;\r
884             \r
885                  // do something\r
886             \r
887              NotificationManager.Post(notification);\r
888              </code>\r
889              </example>\r
890              <privilege>http://tizen.org/privilege/notification</privilege>\r
891         </member>\r
892         <member name="M:Tizen.Applications.Notifications.NotificationManager.Update(Tizen.Applications.Notifications.Notification)">\r
893              <summary>\r
894              Updates a posted notification.\r
895              </summary>\r
896              <param name="notification">Notification to update.</param>\r
897              <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
898              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
899              <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
900              <example>\r
901              <code>\r
902              string tag = "first tag";\r
903             \r
904              Notification notification = new Notification\r
905              {\r
906                  Title = "title",\r
907                  Content = "content",\r
908                  Icon = "absolute icon path",\r
909                  Tag = tag\r
910              };\r
911             \r
912              Notification.AccessorySet accessory = new Notification.AccessorySet\r
913              {\r
914                  LedOption = AccessoryOption.On,\r
915                  VibrationOption = AccessoryOption.Custom,\r
916                  VibrationPath = "vibration absolute path"\r
917              }\r
918              notification.Accessory = accessory;\r
919             \r
920              NotificationManager.Post(notification);\r
921             \r
922                  // do something\r
923             \r
924              Notification loadNotification = NotificationManager.Load(tag);\r
925             \r
926              loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0);\r
927             \r
928              Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress));\r
929              thread.IsBackground = true;\r
930              thread.Start(notification);\r
931             \r
932                ...\r
933             \r
934              static void UpdateProgress(Object obj)\r
935              {\r
936                  Notification notification = (Notification)obj;\r
937             \r
938                  for (double current = 1.0; current &lt;= 100.0; current = current + 1.0)\r
939                  {\r
940                      notification.Progress.ProgressCurrent = current;\r
941                      NotificationManager.Update(notification);\r
942                      Thread.Sleep(300);\r
943                  }\r
944              }\r
945              </code>\r
946              </example>\r
947              <privilege>http://tizen.org/privilege/notification</privilege>\r
948              <pre>\r
949              Post method should be called on the notification object.\r
950              </pre>\r
951         </member>\r
952         <member name="M:Tizen.Applications.Notifications.NotificationManager.Delete(Tizen.Applications.Notifications.Notification)">\r
953              <summary>\r
954              Deletes a posted notification.\r
955              </summary>\r
956              <param name="notification">Notification to remove.</param>\r
957              <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
958              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
959              <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
960              <example>\r
961              <code>\r
962              Notification notification = new Notification\r
963              {\r
964                  Title = "title",\r
965                  Content = "content",\r
966                  Icon = "absolute icon path",\r
967                  Tag = "first notification"\r
968              };\r
969              NotificationManager.Post(notification);\r
970             \r
971                  // do something\r
972             \r
973              NotificationManager.Delete(notification);\r
974              </code>\r
975              </example>\r
976              <privilege>http://tizen.org/privilege/notification</privilege>\r
977              <pre>\r
978              Post method should be called on the notification object.\r
979              </pre>\r
980         </member>\r
981         <member name="M:Tizen.Applications.Notifications.NotificationManager.DeleteAll">\r
982              <summary>\r
983              Removes all posted notifications of calling application.\r
984              </summary>\r
985              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
986              <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
987              <example>\r
988              <code>\r
989              Notification firstNotification = new Notification\r
990              {\r
991                  Title = "title",\r
992                  Content = "content",\r
993                  Icon = "absolute icon path",\r
994                  Tag = "first notification"\r
995              };\r
996              NotificationManager.Post(firstNotification);\r
997             \r
998              Notification secondNotification = new Notification\r
999              {\r
1000                  Title = "title",\r
1001                  Content = "content",\r
1002                  Icon = "absolute icon path",\r
1003                  Tag = "second notification"\r
1004              };\r
1005              NotificationManager.Post(secondNotification);\r
1006              NotificationManager.DeleteAll();\r
1007              </code>\r
1008              </example>\r
1009              <privilege>http://tizen.org/privilege/notification</privilege>\r
1010         </member>\r
1011         <member name="M:Tizen.Applications.Notifications.NotificationManager.Load(System.String)">\r
1012              <summary>\r
1013              Searches for a posted notification which has the specified tag and has not been deleted yet.\r
1014              </summary>\r
1015              <remarks>\r
1016              Load method should be called only for notifications, which have been posted using the NotificationManager.Post method.\r
1017              If two or more notifications share the same tag, the notification posted most recently is returned.\r
1018              </remarks>\r
1019              <param name="tag">Tag used to query.</param>\r
1020              <returns>Notification Object with specified tag.</returns>\r
1021              <exception cref="T:System.ArgumentException">Throwing the same exception when argument is invalid and when the tag does not exist is misleading.</exception>\r
1022              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
1023              <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
1024              <example>\r
1025              <code>\r
1026              Notification notification = new Notification\r
1027              {\r
1028                  Title = "title",\r
1029                  Content = "content",\r
1030                  Icon = "absolute icon path",\r
1031                  Tag = "first notification"\r
1032              };\r
1033              NotificationManager.Post(notification);\r
1034             \r
1035                  // do someting\r
1036             \r
1037              Notification loadNotification = NotificationManager.Load("first notification");\r
1038              </code>\r
1039              </example>\r
1040              <privilege>http://tizen.org/privilege/notification</privilege>\r
1041         </member>\r
1042         <member name="M:Tizen.Applications.Notifications.NotificationManager.SaveTemplate(Tizen.Applications.Notifications.Notification,System.String)">\r
1043              <summary>\r
1044              Saves a notification template to the notification database.\r
1045              </summary>\r
1046              <param name="notification">Notification to save as template.</param>\r
1047              <param name="name">Template name.</param>\r
1048              <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
1049              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
1050              <exception cref="T:System.InvalidOperationException">Thrown when it can't be saved as a template.</exception>\r
1051              <example>\r
1052              <code>\r
1053              Notification notification = new Notification\r
1054              {\r
1055                  Title = "title",\r
1056                  Content = "content",\r
1057                  Icon = "absolute icon path",\r
1058                  Tag = "first notification"\r
1059              };\r
1060             \r
1061              Notification.Accessory accessory = new Notification.Accessory\r
1062              {\r
1063                  LedOption = AccessoryOption.On,\r
1064                  VibrationOption = AccessoryOption.Custom,\r
1065                  VibrationPath = "vibration absolute path"\r
1066              }\r
1067              notification.setAccessory(accessory);\r
1068             \r
1069                  // do something\r
1070             \r
1071              NotificationManager.Post(notification);\r
1072             \r
1073              Notification.LockStyle style = new Notification.LockStyle\r
1074              {\r
1075                  IconPath = "icon path",\r
1076                  ThumbnailPath = "Thumbnail path"\r
1077              }\r
1078              notification.AddStyle(style);\r
1079              NotificationManager.SaveTemplate(notification, "firstTemplate");\r
1080              </code>\r
1081              </example>\r
1082              <privilege>http://tizen.org/privilege/notification</privilege>\r
1083         </member>\r
1084         <member name="M:Tizen.Applications.Notifications.NotificationManager.LoadTemplate(System.String)">\r
1085              <summary>\r
1086              Loads a notification template from the notification database.\r
1087              </summary>\r
1088              <param name="name">Template name.</param>\r
1089              <returns>Notification Object with inputted template name.</returns>\r
1090              <exception cref="T:System.ArgumentException">Throwing the same exception when argument is invalid and when the template does not exist is misleading.</exception>\r
1091              <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
1092              <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
1093              <example>\r
1094              <code>\r
1095              Notification notification = new Notification\r
1096              {\r
1097                  Title = "title",\r
1098                  Content = "content",\r
1099                  Icon = "absolute icon path",\r
1100                  Tag = "first notification"\r
1101              };\r
1102             \r
1103              Notification.Accessory accessory = new Notification.Accessory\r
1104              {\r
1105                  LedOption = AccessoryOption.On,\r
1106                  VibrationOption = AccessoryOption.Custom,\r
1107                  VibrationPath = "vibration absolute path"\r
1108              }\r
1109              notification.setAccessory(accessory);\r
1110             \r
1111                  // do something\r
1112             \r
1113              NotificationManager.Post(notification);\r
1114             \r
1115              Notification.LockStyle style = new Notification.LockStyle\r
1116              {\r
1117                  IconPath = "icon path",\r
1118                  ThumbnailPath = "Thumbnail path"\r
1119              }\r
1120              notification.AddStyle(style);\r
1121              NotificationManager.SaveTemplate(notification, "firstTemplate");\r
1122              Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate");\r
1123              </code>\r
1124              </example>\r
1125              <privilege>http://tizen.org/privilege/notification</privilege>\r
1126         </member>\r
1127         <member name="M:Tizen.Applications.Notifications.NotificationManager.GetBlockState">\r
1128             <summary>\r
1129             Gets notification block state.\r
1130             </summary>\r
1131             <remarks>\r
1132             The user can set the notification block state in settings.\r
1133             The block state indicates whether or not notifications can be posted.\r
1134             Additionally, only notifications to the notification panel are allowed in "Do not disturb mode".\r
1135             Sound, vibrate, and active notifications are blocked.\r
1136             </remarks>\r
1137             <returns>NotificationBlockState is a state if notification is posted.</returns>\r
1138             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
1139             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
1140             <privilege>http://tizen.org/privilege/notification</privilege>\r
1141         </member>\r
1142         <member name="P:Tizen.Applications.Notifications.NotificationSafeHandle.IsInvalid">\r
1143             <summary>\r
1144             Gets a value that indicates whether the handle is invalid.\r
1145             </summary>\r
1146         </member>\r
1147     </members>\r
1148 </doc>\r