1 <?xml version="1.0"?>
\r
4 <name>Tizen.Applications.Notification</name>
\r
7 <member name="T:Tizen.Applications.Notifications.Notification">
\r
9 This class contains common properties and methods of notifications.
\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
17 This class contains common properties and methods of notifications.
\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
25 This class contains common properties and methods of notifications.
\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
33 This class contains common properties and methods of notifications.
\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
41 The class contains common properties and methods of notifications.
\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
49 This class contains common properties and methods of notifications.
\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
57 This class contains common properties and methods of notifications.
\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
65 This class contains common properties and methods of notifications.
\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
73 This class contains common properties and methods of notifications.
\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
81 This class contains common properties and methods of notifications.
\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
89 <member name="M:Tizen.Applications.Notifications.Notification.#ctor">
\r
91 Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification"/> class.
\r
94 <member name="P:Tizen.Applications.Notifications.Notification.Tag">
\r
96 Gets or sets the tag of notification.
\r
99 <member name="P:Tizen.Applications.Notifications.Notification.Title">
\r
101 Gets or sets the title of notification.
\r
104 <member name="P:Tizen.Applications.Notifications.Notification.Icon">
\r
106 Gets or sets the icon of notification.
\r
107 You should set an absolute path for an image file.
\r
110 <member name="P:Tizen.Applications.Notifications.Notification.SubIcon">
\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
117 <member name="P:Tizen.Applications.Notifications.Notification.Content">
\r
119 Gets or sets the content of notification.
\r
122 <member name="P:Tizen.Applications.Notifications.Notification.IsTimeStampVisible">
\r
124 Gets or sets a value indicating whether TimeStamp of the notification is Visible or not.
\r
128 <member name="P:Tizen.Applications.Notifications.Notification.TimeStamp">
\r
130 Gets or sets the TimeStamp of notification.
\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
138 <member name="P:Tizen.Applications.Notifications.Notification.Action">
\r
140 Gets or sets action, which is invoked when the notification is clicked.
\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
145 <seealso cref="T:Tizen.Applications.AppControl"></seealso>
\r
147 <member name="P:Tizen.Applications.Notifications.Notification.Count">
\r
149 Gets or sets count, which is displayed at the right side of the notification.
\r
152 You must set only positive number.
\r
153 If you set count to negative number, this property throws exception.
\r
155 <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
\r
157 <member name="P:Tizen.Applications.Notifications.Notification.Property">
\r
159 Gets or sets property.
\r
161 <seealso cref="T:Tizen.Applications.Notifications.NotificationProperty"></seealso>
\r
163 <member name="P:Tizen.Applications.Notifications.Notification.Progress">
\r
165 Gets or sets <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> object for display at notification.
\r
167 <seealso cref="T:Tizen.Applications.Notifications.Notification.ProgressType"></seealso>
\r
169 <member name="P:Tizen.Applications.Notifications.Notification.Accessory">
\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
174 If you set it to null, the already set AccessorySet will be initialized.
\r
178 Notification notification = new Notification
\r
180 Title = "Notification",
\r
181 Content = "Hello Tizen",
\r
182 Icon = "Icon path",
\r
186 Notification.AccessorySet accessory = new Notification.AccessorySet
\r
188 SoundOption = AccessoryOption.Custom,
\r
189 SoundPath = "Sound File Path",
\r
190 IsVibration = true,
\r
191 LedOption = AccessoryOption.Custom,
\r
194 LedColor = Color.Lime
\r
197 notification.Accessory = accessory;
\r
199 NotificationManager.Post(notification);
\r
203 <member name="P:Tizen.Applications.Notifications.Notification.IsVisible">
\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
209 <member name="P:Tizen.Applications.Notifications.Notification.Handle">
\r
211 Gets or sets NotificationSafeHandle.
\r
214 <member name="P:Tizen.Applications.Notifications.Notification.PrivID">
\r
216 Gets or sets private ID.
\r
219 <member name="M:Tizen.Applications.Notifications.Notification.AddStyle(Tizen.Applications.Notifications.Notification.StyleBase)">
\r
221 Method for adding various styles to be applied to notification.
\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
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
231 Notification notification = new Notification
\r
233 Title = "Notification",
\r
234 Content = "Hello Tizen",
\r
235 Icon = "Icon path",
\r
239 Notification.LockStyle lockStyle = new Notification.LockStyle
\r
241 IconPath = "Icon path",
\r
242 ThumbnailPath = "Thumbnail Path"
\r
245 notification.AddStyle(lockStyle);
\r
247 NotificationManager.Post(notification);
\r
251 <member name="M:Tizen.Applications.Notifications.Notification.RemoveStyle``1">
\r
253 Method to remove style you already added.
\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
258 <member name="M:Tizen.Applications.Notifications.Notification.GetStyle``1">
\r
260 Method to get style you already added.
\r
262 <typeparam name="T">Type of notification style to be queried.</typeparam>
\r
264 The Notification.Style object associated with the given style.
\r
266 <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
\r
268 <member name="M:Tizen.Applications.Notifications.Notification.SetExtraData(System.String,Tizen.Applications.Bundle)">
\r
270 Method to set extra data to add extra data.
\r
273 The type of extra data is bundle.
\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
280 Notification notification = new Notification
\r
282 Title = "Notification",
\r
283 Content = "Hello Tizen",
\r
284 Icon = "Icon path",
\r
287 Bundle bundle = new Bundle();
\r
288 bundle.AddItem("key", "value");
\r
290 notification.SetExtraData("firstKey", bundle);
\r
294 <member name="M:Tizen.Applications.Notifications.Notification.RemoveExtraData(System.String)">
\r
296 Method to remove extra you already added.
\r
299 The type of extra data is bundle.
\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
304 <member name="M:Tizen.Applications.Notifications.Notification.GetExtraData(System.String)">
\r
306 Method to get extra data you already set.
\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
312 <member name="M:Tizen.Applications.Notifications.Notification.Dispose">
\r
314 Releases any unmanaged resources used by this object.
\r
317 <member name="T:Tizen.Applications.Notifications.Notification.AccessorySet">
\r
319 Class for notification AccessorySet, which includes vibration, LED, and sound option.
\r
322 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundOption">
\r
324 Gets or sets the sound option. Default to AccessoryOption.Off.
\r
327 If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown.
\r
330 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundPath">
\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
336 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.CanVibrate">
\r
338 Gets or sets a value indicating whether vibration is operated. Default is false.
\r
341 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOption">
\r
343 Gets or sets the led option. The default value is AccessoryOption.Off.
\r
346 If you set AccessoryOption.Custom and not set LedColor, the LED will show default color.
\r
349 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOnMillisecond">
\r
351 Gets or sets the on time so that it looks like the device's LED is blinking.
\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
359 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOffMillisecond">
\r
361 Gets or sets the off time so that it looks like the device's LED is blinking.
\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
368 <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedColor">
\r
370 Gets or sets the LED color that you would like the LED on the device to blink.
\r
373 If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color.
\r
376 <member name="T:Tizen.Applications.Notifications.Notification.ActiveStyle">
\r
378 Class for generating active style notification.
\r
381 <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.#ctor">
\r
383 Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ActiveStyle"/> class.
\r
386 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.BackgroundImage">
\r
388 Gets or sets an absolute path for an image file to display on the background of active notification.
\r
391 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.IsAutoRemove">
\r
393 Gets or sets a value indicating whether the active notification is removed automatically. Default value is true.
\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
401 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.DefaultButton">
\r
403 Gets or sets the default button to display highlight on the active notification.
\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
410 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.ReplyAction">
\r
412 Gets or sets a ReplyAction to this active notification style.
\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
421 ButtonAction button = new ButtonAction
\r
423 Index = ButtonIndex.First,
\r
425 Action = new AppControl{ ApplicationId = "org.tizen.app" };
\r
428 ReplyAction reply = new ReplyAction
\r
430 ParentIndex = ButtonIndex.First;
\r
431 PlaceHolderText = "Please write your reply."
\r
433 Button = new ButtonAction
\r
436 ImagePath = "image path"
\r
437 Action = new AppControl{ ApplicationId = "org.tizen.app" };
\r
441 ActiveStyle active = new ActiveStyle
\r
444 BackgroundImage = "image path",
\r
445 ReplyAction = reply
\r
448 active.AddButtonAction(button);
\r
452 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByUserAction">
\r
454 Gets or sets Action which is invoked when notification is hidden by user.
\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
461 <seealso cref="T:Tizen.Applications.AppControl"></seealso>
\r
463 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByTimeoutAction">
\r
465 Gets or sets Action which is invoked when there is no any response by user until hide timeout.
\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
473 <seealso cref="T:Tizen.Applications.AppControl"></seealso>
\r
475 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByExternalAction">
\r
477 Gets or sets Action which is invoked when the notification is hidden by external factor.
\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
484 <seealso cref="T:Tizen.Applications.AppControl"></seealso>
\r
486 <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.Key">
\r
488 Gets the key of ActiveStyle.
\r
491 <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.SetRemoveTime(System.Int32,System.Int32)">
\r
493 Method to set time to hide or delete notification.
\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
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
503 <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetRemoveTime(System.Int32@,System.Int32@)">
\r
505 Method to get time set to hide or delete notification.
\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
510 <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.AddButtonAction(Tizen.Applications.Notifications.Notification.ButtonAction)">
\r
512 Method to add a button to the active notification style.
\r
513 Buttons are displayed on the notification.
\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
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
524 ButtonAction button = new ButtonAction
\r
528 Action = new AppControl{ ApplicationId = "org.tizen.app" };
\r
531 ActiveStyle active = new ActiveStyle
\r
533 IsAutoRemove = true,
\r
534 BackgroundImage = "image path",
\r
537 active.AddButtonAction(button);
\r
542 <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.RemoveButtonAction(Tizen.Applications.Notifications.ButtonIndex)">
\r
544 Removes the ButtonAction you already added.
\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
549 <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetButtonAction(Tizen.Applications.Notifications.ButtonIndex)">
\r
551 Gets the ButtonAction of the active notification.
\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
557 <member name="T:Tizen.Applications.Notifications.Notification.ButtonAction">
\r
559 This class helps you to set the button on active style of notification.
\r
562 It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button.
\r
565 <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Index">
\r
567 Gets or sets the index of the button, which appeares as notification.
\r
570 <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Text">
\r
572 Gets or sets the text describing the button.
\r
575 <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.ImagePath">
\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
581 <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Action">
\r
583 Gets or sets the action, which is invoked when the button is clicked.
\r
586 If you don't set action, nothing happens when the button is clicked.
\r
590 ButtonAction button = new ButtonAction
\r
592 Index = ButtonIndex.First,
\r
594 ImagePath = "image path",
\r
595 Action = new AppControl{ ApplicationId = "org.tizen.app" };
\r
599 <seealso cref="T:Tizen.Applications.AppControl"></seealso>
\r
601 <member name="T:Tizen.Applications.Notifications.Notification.IndicatorStyle">
\r
603 Class for generating indicator style notification.
\r
606 <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.IconPath">
\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
612 <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.SubText">
\r
614 Gets or sets a sub text for displaying indicator style.
\r
617 <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.Key">
\r
619 Gets the key of IndicatorStyle.
\r
622 <member name="T:Tizen.Applications.Notifications.Notification.LockStyle">
\r
624 Class for generating lock style notification.
\r
627 <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.IconPath">
\r
629 Gets or sets an absolute path for an image file to display the icon of lock style.
\r
632 <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.ThumbnailPath">
\r
634 Gets or sets an absolute path for a thumbnail image file to display on lock style.
\r
637 <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.Key">
\r
639 Gets the key of LockStyle.
\r
642 <member name="T:Tizen.Applications.Notifications.Notification.MakerBase">
\r
644 An object that helps notification to make to SafeHandle.
\r
647 <member name="T:Tizen.Applications.Notifications.Notification.ProgressType">
\r
649 Class for displaying progress notification.
\r
650 You must initialize progress category, current, and max value when you create an object.
\r
653 <member name="M:Tizen.Applications.Notifications.Notification.ProgressType.#ctor(Tizen.Applications.Notifications.ProgressCategory,System.Double,System.Double)">
\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
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
663 <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.Category">
\r
665 Gets or sets category of ProgressType.
\r
667 <seealso cref="T:Tizen.Applications.Notifications.ProgressCategory"></seealso>
\r
669 <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressCurrent">
\r
671 Gets or sets current value of ProgressType.
\r
673 <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>
\r
675 <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressMax">
\r
677 Gets or sets max value of ProgressType.
\r
679 <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>
\r
681 <member name="T:Tizen.Applications.Notifications.Notification.ReplyAction">
\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
687 <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ParentIndex">
\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
694 <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.PlaceHolderText">
\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
700 <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ReplyMax">
\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
706 Default value is 160.
\r
709 <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.Button">
\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
715 If you set it to null, the already set ButtonAction will be removed.
\r
719 ReplyAction button = new ReplyAction
\r
721 ParentIndex = ButtonIndex.Second;
\r
722 PlaceHolderText = "Please write your reply."
\r
724 Button = new ButtonAction
\r
727 ImagePath = "image path",
\r
728 Action = new AppControl{ ApplicationId = "org.tizen.app" };
\r
734 <member name="T:Tizen.Applications.Notifications.Notification.StyleBase">
\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
740 <member name="T:Tizen.Applications.Notifications.ProgressCategory">
\r
742 Enumeration for the progress category.
\r
745 <member name="F:Tizen.Applications.Notifications.ProgressCategory.Percent">
\r
747 Value for percent type.
\r
750 <member name="F:Tizen.Applications.Notifications.ProgressCategory.Time">
\r
752 Value for time type.
\r
755 <member name="F:Tizen.Applications.Notifications.ProgressCategory.PendingBar">
\r
757 Value for pending type, which is not the updated progress current value.
\r
760 <member name="T:Tizen.Applications.Notifications.AccessoryOption">
\r
762 Enumeration for the accessory option.
\r
765 <member name="F:Tizen.Applications.Notifications.AccessoryOption.Off">
\r
767 Value for off accessory option.
\r
770 <member name="F:Tizen.Applications.Notifications.AccessoryOption.On">
\r
772 Value for on accessory option.
\r
775 <member name="F:Tizen.Applications.Notifications.AccessoryOption.Custom">
\r
777 Value for the custom accessory option.
\r
780 <member name="T:Tizen.Applications.Notifications.ButtonIndex">
\r
782 Enumeration for the button index.
\r
785 <member name="F:Tizen.Applications.Notifications.ButtonIndex.None">
\r
787 Value for the default button index.
\r
790 <member name="F:Tizen.Applications.Notifications.ButtonIndex.First">
\r
792 Value for the first button index.
\r
795 <member name="F:Tizen.Applications.Notifications.ButtonIndex.Second">
\r
797 Value for the second button index.
\r
800 <member name="F:Tizen.Applications.Notifications.ButtonIndex.Third">
\r
802 Value for the third button index.
\r
805 <member name="T:Tizen.Applications.Notifications.NotificationProperty">
\r
807 Enumeration for the notification particular property.
\r
810 <member name="F:Tizen.Applications.Notifications.NotificationProperty.None">
\r
812 Value for adjust nothing.
\r
815 <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisplayOnlySimMode">
\r
817 Value for display only SIM card inserted.
\r
820 <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAppLaunch">
\r
822 Value for disable application launch when it is selected.
\r
825 <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAutoDelete">
\r
827 Value for disable auto delete when it is selected.
\r
830 <member name="F:Tizen.Applications.Notifications.NotificationProperty.VolatileDisplay">
\r
832 Value for deleted when device is rebooted even though notification is not set ongoing.
\r
835 <member name="T:Tizen.Applications.Notifications.NotificationBlockState">
\r
837 Enumeration for the block state.
\r
840 <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Allowed">
\r
842 Value to check if the app is allowed to post notification.
\r
845 <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Blocked">
\r
847 Value to check if the app is not allowed to post any notification.
\r
850 <member name="F:Tizen.Applications.Notifications.NotificationBlockState.DoNotDisturb">
\r
852 Value to check if the do not disturb mode is set by the user.
\r
855 <member name="T:Tizen.Applications.Notifications.NotificationManager">
\r
857 NotificationManager class to post, update, delete, and get notification.
\r
860 <member name="M:Tizen.Applications.Notifications.NotificationManager.Post(Tizen.Applications.Notifications.Notification)">
\r
862 Posts a new notification.
\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
870 Notification notification = new Notification
\r
873 Content = "content",
\r
874 Icon = "absolute icon path",
\r
875 Tag = "first notification"
\r
878 Notification.AccessorySet accessory = new Notification.AccessorySet
\r
880 SoundOption = AccessoryOption.On,
\r
883 notification.Accessory = accessory;
\r
887 NotificationManager.Post(notification);
\r
890 <privilege>http://tizen.org/privilege/notification</privilege>
\r
892 <member name="M:Tizen.Applications.Notifications.NotificationManager.Update(Tizen.Applications.Notifications.Notification)">
\r
894 Updates a posted notification.
\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
902 string tag = "first tag";
\r
904 Notification notification = new Notification
\r
907 Content = "content",
\r
908 Icon = "absolute icon path",
\r
912 Notification.AccessorySet accessory = new Notification.AccessorySet
\r
914 LedOption = AccessoryOption.On,
\r
915 VibrationOption = AccessoryOption.Custom,
\r
916 VibrationPath = "vibration absolute path"
\r
918 notification.Accessory = accessory;
\r
920 NotificationManager.Post(notification);
\r
924 Notification loadNotification = NotificationManager.Load(tag);
\r
926 loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0);
\r
928 Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress));
\r
929 thread.IsBackground = true;
\r
930 thread.Start(notification);
\r
934 static void UpdateProgress(Object obj)
\r
936 Notification notification = (Notification)obj;
\r
938 for (double current = 1.0; current <= 100.0; current = current + 1.0)
\r
940 notification.Progress.ProgressCurrent = current;
\r
941 NotificationManager.Update(notification);
\r
947 <privilege>http://tizen.org/privilege/notification</privilege>
\r
949 Post method should be called on the notification object.
\r
952 <member name="M:Tizen.Applications.Notifications.NotificationManager.Delete(Tizen.Applications.Notifications.Notification)">
\r
954 Deletes a posted notification.
\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
962 Notification notification = new Notification
\r
965 Content = "content",
\r
966 Icon = "absolute icon path",
\r
967 Tag = "first notification"
\r
969 NotificationManager.Post(notification);
\r
973 NotificationManager.Delete(notification);
\r
976 <privilege>http://tizen.org/privilege/notification</privilege>
\r
978 Post method should be called on the notification object.
\r
981 <member name="M:Tizen.Applications.Notifications.NotificationManager.DeleteAll">
\r
983 Removes all posted notifications of calling application.
\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
989 Notification firstNotification = new Notification
\r
992 Content = "content",
\r
993 Icon = "absolute icon path",
\r
994 Tag = "first notification"
\r
996 NotificationManager.Post(firstNotification);
\r
998 Notification secondNotification = new Notification
\r
1001 Content = "content",
\r
1002 Icon = "absolute icon path",
\r
1003 Tag = "second notification"
\r
1005 NotificationManager.Post(secondNotification);
\r
1006 NotificationManager.DeleteAll();
\r
1009 <privilege>http://tizen.org/privilege/notification</privilege>
\r
1011 <member name="M:Tizen.Applications.Notifications.NotificationManager.Load(System.String)">
\r
1013 Searches for a posted notification which has the specified tag and has not been deleted yet.
\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
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
1026 Notification notification = new Notification
\r
1029 Content = "content",
\r
1030 Icon = "absolute icon path",
\r
1031 Tag = "first notification"
\r
1033 NotificationManager.Post(notification);
\r
1037 Notification loadNotification = NotificationManager.Load("first notification");
\r
1040 <privilege>http://tizen.org/privilege/notification</privilege>
\r
1042 <member name="M:Tizen.Applications.Notifications.NotificationManager.SaveTemplate(Tizen.Applications.Notifications.Notification,System.String)">
\r
1044 Saves a notification template to the notification database.
\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
1053 Notification notification = new Notification
\r
1056 Content = "content",
\r
1057 Icon = "absolute icon path",
\r
1058 Tag = "first notification"
\r
1061 Notification.Accessory accessory = new Notification.Accessory
\r
1063 LedOption = AccessoryOption.On,
\r
1064 VibrationOption = AccessoryOption.Custom,
\r
1065 VibrationPath = "vibration absolute path"
\r
1067 notification.setAccessory(accessory);
\r
1071 NotificationManager.Post(notification);
\r
1073 Notification.LockStyle style = new Notification.LockStyle
\r
1075 IconPath = "icon path",
\r
1076 ThumbnailPath = "Thumbnail path"
\r
1078 notification.AddStyle(style);
\r
1079 NotificationManager.SaveTemplate(notification, "firstTemplate");
\r
1082 <privilege>http://tizen.org/privilege/notification</privilege>
\r
1084 <member name="M:Tizen.Applications.Notifications.NotificationManager.LoadTemplate(System.String)">
\r
1086 Loads a notification template from the notification database.
\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
1095 Notification notification = new Notification
\r
1098 Content = "content",
\r
1099 Icon = "absolute icon path",
\r
1100 Tag = "first notification"
\r
1103 Notification.Accessory accessory = new Notification.Accessory
\r
1105 LedOption = AccessoryOption.On,
\r
1106 VibrationOption = AccessoryOption.Custom,
\r
1107 VibrationPath = "vibration absolute path"
\r
1109 notification.setAccessory(accessory);
\r
1113 NotificationManager.Post(notification);
\r
1115 Notification.LockStyle style = new Notification.LockStyle
\r
1117 IconPath = "icon path",
\r
1118 ThumbnailPath = "Thumbnail path"
\r
1120 notification.AddStyle(style);
\r
1121 NotificationManager.SaveTemplate(notification, "firstTemplate");
\r
1122 Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate");
\r
1125 <privilege>http://tizen.org/privilege/notification</privilege>
\r
1127 <member name="M:Tizen.Applications.Notifications.NotificationManager.GetBlockState">
\r
1129 Gets notification block state.
\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
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
1142 <member name="P:Tizen.Applications.Notifications.NotificationSafeHandle.IsInvalid">
\r
1144 Gets a value that indicates whether the handle is invalid.
\r