-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.Applications.Notification</name>
- </assembly>
- <members>
- <member name="T:Tizen.Applications.Notifications.Notification">
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- The class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- <summary>
- This class contains common properties and methods of notifications.
- </summary>
- <remarks>
- A notification is a message that is displayed on the notification area.
- It is created to notify information to the user through the application.
- This class helps you to provide method and property for creating notification object.
- </remarks>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification"/> class.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Tag">
- <summary>
- Gets or sets the tag of notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Title">
- <summary>
- Gets or sets the title of notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Icon">
- <summary>
- Gets or sets the icon of notification.
- You should set an absolute path for an image file.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.SubIcon">
- <summary>
- Gets or sets the sub icon of notification.
- This SubIcon is displayed in Icon you set.
- You should set an absolute path for an image file.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Content">
- <summary>
- Gets or sets the content of notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.IsTimeStampVisible">
- <summary>
- Gets or sets a value indicating whether TimeStamp of the notification is Visible or not.
- Default to true.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.TimeStamp">
- <summary>
- Gets or sets the TimeStamp of notification.
- </summary>
- <remarks>
- If you don't set TimeStamp, it will set the value when the notification is posted.
- TimeStamp requires NotificationManager.Post() to be called.
- If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification.
- </remarks>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Action">
- <summary>
- Gets or sets action, which is invoked when the notification is clicked.
- </summary>
- <remarks>
- If you set it to null, the already set AppControl will be removed and nothing will happen when you click on notification.
- </remarks>
- <seealso cref="T:Tizen.Applications.AppControl"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Count">
- <summary>
- Gets or sets count, which is displayed at the right side of the notification.
- </summary>
- <remarks>
- You must set only positive number.
- If you set count to negative number, this property throws exception.
- </remarks>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Property">
- <summary>
- Gets or sets property.
- </summary>
- <seealso cref="T:Tizen.Applications.Notifications.NotificationProperty"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Progress">
- <summary>
- Gets or sets <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> object for display at notification.
- </summary>
- <seealso cref="T:Tizen.Applications.Notifications.Notification.ProgressType"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Accessory">
- <summary>
- Gets or sets <see cref="T:Tizen.Applications.Notifications.Notification.AccessorySet"/> which is included vibration, LED and sound option to be applied at notification.
- </summary>
- <remarks>
- If you set it to null, the already set AccessorySet will be initialized.
- </remarks>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "Notification",
- Content = "Hello Tizen",
- Icon = "Icon path",
- Count = 3
- };
-
- Notification.AccessorySet accessory = new Notification.AccessorySet
- {
- SoundOption = AccessoryOption.Custom,
- SoundPath = "Sound File Path",
- IsVibration = true,
- LedOption = AccessoryOption.Custom,
- LedOnMs = 100;
- LedOffMs = 50;
- LedColor = Color.Lime
- };
-
- notification.Accessory = accessory;
-
- NotificationManager.Post(notification);
- </code>
- </example>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.IsVisible">
- <summary>
- Gets or sets a value indicating whether notification is displayed on the default viewer.
- If you set false and add style, you can see only style notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.Handle">
- <summary>
- Gets or sets NotificationSafeHandle.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.PrivID">
- <summary>
- Gets or sets private ID.
- </summary>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.AddStyle(Tizen.Applications.Notifications.Notification.StyleBase)">
- <summary>
- Method for adding various styles to be applied to notification.
- </summary>
- <remarks>
- The user always see about valid notification style. If you add a style which is not supported in platform,
- this method has no effect.
- </remarks>
- <param name="style">The style to be applied to notification.</param>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "Notification",
- Content = "Hello Tizen",
- Icon = "Icon path",
- Count = 3
- };
-
- Notification.LockStyle lockStyle = new Notification.LockStyle
- {
- IconPath = "Icon path",
- ThumbnailPath = "Thumbnail Path"
- };
-
- notification.AddStyle(lockStyle);
-
- NotificationManager.Post(notification);
- </code>
- </example>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.RemoveStyle``1">
- <summary>
- Method to remove style you already added.
- </summary>
- <typeparam name="T">Type of notification style to be queried.</typeparam>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.GetStyle``1">
- <summary>
- Method to get style you already added.
- </summary>
- <typeparam name="T">Type of notification style to be queried.</typeparam>
- <returns>
- The Notification.Style object associated with the given style.
- </returns>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.SetExtraData(System.String,Tizen.Applications.Bundle)">
- <summary>
- Method to set extra data to add extra data.
- </summary>
- <remarks>
- The type of extra data is bundle.
- </remarks>
- <param name="key">The key of the extra data you want to add.</param>
- <param name="value">The value you want to add.</param>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "Notification",
- Content = "Hello Tizen",
- Icon = "Icon path",
- };
-
- Bundle bundle = new Bundle();
- bundle.AddItem("key", "value");
-
- notification.SetExtraData("firstKey", bundle);
- </code>
- </example>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.RemoveExtraData(System.String)">
- <summary>
- Method to remove extra you already added.
- </summary>
- <remarks>
- The type of extra data is bundle.
- </remarks>
- <param name="key">The key of the extra data to add.</param>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.GetExtraData(System.String)">
- <summary>
- Method to get extra data you already set.
- </summary>
- <param name="key">The key of the extra data to get.</param>
- <returns>Bundle Object that include extra data</returns>
- <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.Dispose">
- <summary>
- Releases any unmanaged resources used by this object.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.AccessorySet">
- <summary>
- Class for notification AccessorySet, which includes vibration, LED, and sound option.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundOption">
- <summary>
- Gets or sets the sound option. Default to AccessoryOption.Off.
- </summary>
- <remarks>
- If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown.
- </remarks>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundPath">
- <summary>
- Gets or sets the sound path, It will play on the sound file you set.
- You should set an absolute path for a sound file.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.CanVibrate">
- <summary>
- Gets or sets a value indicating whether vibration is operated. Default is false.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOption">
- <summary>
- Gets or sets the led option. The default value is AccessoryOption.Off.
- </summary>
- <remarks>
- If you set AccessoryOption.Custom and not set LedColor, the LED will show default color.
- </remarks>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOnMillisecond">
- <summary>
- Gets or sets the on time so that it looks like the device's LED is blinking.
- </summary>
- <remarks>
- Default value of LedOnMillisecond is 0.
- The rate is specified in terms of the number of Milliseconds to be on.
- You must set the on and off times at the same time. Otherwise, it may not operate normally.
- </remarks>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOffMillisecond">
- <summary>
- Gets or sets the off time so that it looks like the device's LED is blinking.
- </summary>
- <remarks>
- The rate is specified in terms of the number of Milliseconds to be off.
- You must set the on and off times at the same time. Otherwise, it may not operate normally.
- </remarks>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedColor">
- <summary>
- Gets or sets the LED color that you would like the LED on the device to blink.
- </summary>
- <remarks>
- If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color.
- </remarks>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.ActiveStyle">
- <summary>
- Class for generating active style notification.
- </summary>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ActiveStyle"/> class.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.BackgroundImage">
- <summary>
- Gets or sets an absolute path for an image file to display on the background of active notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.IsAutoRemove">
- <summary>
- Gets or sets a value indicating whether the active notification is removed automatically. Default value is true.
- </summary>
- <remarks>
- IsAutoRemove option lets the active notification to be removed several seconds after it shows.
- When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes
- it or the application, which posted the active notification.
- </remarks>>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.DefaultButton">
- <summary>
- Gets or sets the default button to display highlight on the active notification.
- </summary>
- <remarks>
- The default button for display highlight is only reflected on the Tizen TV.
- If you use this property on other profile, this value has no effect.
- </remarks>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.ReplyAction">
- <summary>
- Gets or sets a ReplyAction to this active notification style.
- </summary>
- <remarks>
- When you add a ReplyAction to the ActiveStyle, the notification UI will show a ReplyAction with button.
- If you set null parameter, ReplyAction is not displayed.
- </remarks>
- <example>
- <code>
-
- ButtonAction button = new ButtonAction
- {
- Index = ButtonIndex.First,
- Text = "Yes"
- Action = new AppControl{ ApplicationId = "org.tizen.app" };
- };
-
- ReplyAction reply = new ReplyAction
- {
- ParentIndex = ButtonIndex.First;
- PlaceHolderText = "Please write your reply."
- ReplyMax = 160,
- Button = new ButtonAction
- {
- Text = "Yes",
- ImagePath = "image path"
- Action = new AppControl{ ApplicationId = "org.tizen.app" };
- };
- };
-
- ActiveStyle active = new ActiveStyle
- {
- AutoRemove = true,
- BackgroundImage = "image path",
- ReplyAction = reply
- };
-
- active.AddButtonAction(button);
- </code>
- </example>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByUserAction">
- <summary>
- Gets or sets Action which is invoked when notification is hidden by user.
- </summary>
- <remarks>
- If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by user.
- The property is only reflected on Tizen TV.
- If you use this API on other profile, this action have no effect
- </remarks>
- <seealso cref="T:Tizen.Applications.AppControl"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByTimeoutAction">
- <summary>
- Gets or sets Action which is invoked when there is no any response by user until hide timeout.
- </summary>
- <remarks>
- This action occurs when there is no response to the notification until the delete timeout set by SetRemoveTime().
- If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by timeout.
- The property is only reflected on Tizen TV.
- If you use this API on other profile, this action settings have no effect
- </remarks>
- <seealso cref="T:Tizen.Applications.AppControl"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByExternalAction">
- <summary>
- Gets or sets Action which is invoked when the notification is hidden by external factor.
- </summary>
- <remarks>
- If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by external factor.
- The property is only reflected on Tizen TV.
- If you use this API on other profile, this action settings have no effect
- </remarks>
- <seealso cref="T:Tizen.Applications.AppControl"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.Key">
- <summary>
- Gets the key of ActiveStyle.
- </summary>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.SetRemoveTime(System.Int32,System.Int32)">
- <summary>
- Method to set time to hide or delete notification.
- </summary>
- <remarks>
- The time settings for hiding and deleting are only reflected on the Tizen TV.
- If you use this API on other profile, this time settings have no effect.
- </remarks>
- <param name="hideTime">The value in seconds when the notification can be hidden from the notification viewer after the notification is posted.</param>
- <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>
- <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetRemoveTime(System.Int32@,System.Int32@)">
- <summary>
- Method to get time set to hide or delete notification.
- </summary>
- <param name="hideTime">The value in seconds when the notification can be hidden from the notification viewer after notification is posted.</param>
- <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>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.AddButtonAction(Tizen.Applications.Notifications.Notification.ButtonAction)">
- <summary>
- Method to add a button to the active notification style.
- Buttons are displayed on the notification.
- </summary>
- <remarks>
- If you add button that has same index, the button is replaced to latest adding button.
- If you don't set an index on ButtonAction, the index is set sequentially from zero.
- </remarks>
- <param name="button">A ButtonAction for appear to the notification.</param>
- <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>
- <example>
- <code>
-
- ButtonAction button = new ButtonAction
- {
- Index = 0,
- Text = "Yes"
- Action = new AppControl{ ApplicationId = "org.tizen.app" };
- };
-
- ActiveStyle active = new ActiveStyle
- {
- IsAutoRemove = true,
- BackgroundImage = "image path",
- };
-
- active.AddButtonAction(button);
-
- </code>
- </example>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.RemoveButtonAction(Tizen.Applications.Notifications.ButtonIndex)">
- <summary>
- Removes the ButtonAction you already added.
- </summary>
- <param name="index">The index to remove a button.</param>
- <returns>true if the element is successfully found and removed; otherwise, false.</returns>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetButtonAction(Tizen.Applications.Notifications.ButtonIndex)">
- <summary>
- Gets the ButtonAction of the active notification.
- </summary>
- <param name="index">The index to get a button you already added.</param>
- <returns>The ButtonAction object, which you already added.</returns>
- <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.ButtonAction">
- <summary>
- This class helps you to set the button on active style of notification.
- </summary>
- <remarks>
- It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button.
- </remarks>>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Index">
- <summary>
- Gets or sets the index of the button, which appeares as notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Text">
- <summary>
- Gets or sets the text describing the button.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.ImagePath">
- <summary>
- Gets or sets the image path that represents the button.
- You should provide an absolute path for an image file.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Action">
- <summary>
- Gets or sets the action, which is invoked when the button is clicked.
- </summary>
- <value>
- If you don't set action, nothing happens when the button is clicked.
- </value>
- <example>
- <code>
- ButtonAction button = new ButtonAction
- {
- Index = ButtonIndex.First,
- text = "Yes",
- ImagePath = "image path",
- Action = new AppControl{ ApplicationId = "org.tizen.app" };
- };
- </code>
- </example>
- <seealso cref="T:Tizen.Applications.AppControl"></seealso>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.IndicatorStyle">
- <summary>
- Class for generating indicator style notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.IconPath">
- <summary>
- Gets or sets an absolute path for an image file.
- If you set IconPath, you can see the icon on the right side of indicator.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.SubText">
- <summary>
- Gets or sets a sub text for displaying indicator style.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.Key">
- <summary>
- Gets the key of IndicatorStyle.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.LockStyle">
- <summary>
- Class for generating lock style notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.IconPath">
- <summary>
- Gets or sets an absolute path for an image file to display the icon of lock style.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.ThumbnailPath">
- <summary>
- Gets or sets an absolute path for a thumbnail image file to display on lock style.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.Key">
- <summary>
- Gets the key of LockStyle.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.MakerBase">
- <summary>
- An object that helps notification to make to SafeHandle.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.ProgressType">
- <summary>
- Class for displaying progress notification.
- You must initialize progress category, current, and max value when you create an object.
- </summary>
- </member>
- <member name="M:Tizen.Applications.Notifications.Notification.ProgressType.#ctor(Tizen.Applications.Notifications.ProgressCategory,System.Double,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> class.
- You must initialize category, current, and max value of the progress.
- </summary>
- <param name="category">The category of progress that appeared on notification.</param>
- <param name="current">The current value of the progress.</param>
- <param name="max">The max value of the progress.</param>
- <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.Category">
- <summary>
- Gets or sets category of ProgressType.
- </summary>
- <seealso cref="T:Tizen.Applications.Notifications.ProgressCategory"></seealso>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressCurrent">
- <summary>
- Gets or sets current value of ProgressType.
- </summary>
- <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressMax">
- <summary>
- Gets or sets max value of ProgressType.
- </summary>
- <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.ReplyAction">
- <summary>
- Class for displaying direct-reply on notification.
- You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ParentIndex">
- <summary>
- Gets or sets the index of button, which appears at notification.
- If you set ParentIndex, ReplyAction is displayed when button matches with ParentIndex that is clicked by the user.
- If you don't set ParentIndex, it appears as notification directly.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.PlaceHolderText">
- <summary>
- Gets or sets the PlaceHolderText of ReplyAction which appears at notification.
- If you set PlaceHolderText, it is displayed to placeholder in notification.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ReplyMax">
- <summary>
- Gets or sets the maximum number of characters that the user can input.
- You must set a ReplyMax. Otherwise user don't write text to placeholder in notification.
- </summary>
- <value>
- Default value is 160.
- </value>
- </member>
- <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.Button">
- <summary>
- Gets or sets the button, which appears as ReplyAction in notification.
- You must set the button, otherwise, a user can't send written text to application, which is set by AppControl.
- </summary>
- <remarks>
- If you set it to null, the already set ButtonAction will be removed.
- </remarks>
- <example>
- <code>
- ReplyAction button = new ReplyAction
- {
- ParentIndex = ButtonIndex.Second;
- PlaceHolderText = "Please write your reply."
- ReplyMax = 160,
- Button = new ButtonAction
- {
- text = "Yes",
- ImagePath = "image path",
- Action = new AppControl{ ApplicationId = "org.tizen.app" };
- };
- };
- </code>
- </example>
- </member>
- <member name="T:Tizen.Applications.Notifications.Notification.StyleBase">
- <summary>
- An object can apply a rich notification style to a notification object.
- If the platform does not provide rich notification, styles in this class have no effect.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.ProgressCategory">
- <summary>
- Enumeration for the progress category.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ProgressCategory.Percent">
- <summary>
- Value for percent type.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ProgressCategory.Time">
- <summary>
- Value for time type.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ProgressCategory.PendingBar">
- <summary>
- Value for pending type, which is not the updated progress current value.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.AccessoryOption">
- <summary>
- Enumeration for the accessory option.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.AccessoryOption.Off">
- <summary>
- Value for off accessory option.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.AccessoryOption.On">
- <summary>
- Value for on accessory option.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.AccessoryOption.Custom">
- <summary>
- Value for the custom accessory option.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.ButtonIndex">
- <summary>
- Enumeration for the button index.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ButtonIndex.None">
- <summary>
- Value for the default button index.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ButtonIndex.First">
- <summary>
- Value for the first button index.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ButtonIndex.Second">
- <summary>
- Value for the second button index.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.ButtonIndex.Third">
- <summary>
- Value for the third button index.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.NotificationProperty">
- <summary>
- Enumeration for the notification particular property.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationProperty.None">
- <summary>
- Value for adjust nothing.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisplayOnlySimMode">
- <summary>
- Value for display only SIM card inserted.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAppLaunch">
- <summary>
- Value for disable application launch when it is selected.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAutoDelete">
- <summary>
- Value for disable auto delete when it is selected.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationProperty.VolatileDisplay">
- <summary>
- Value for deleted when device is rebooted even though notification is not set ongoing.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.NotificationBlockState">
- <summary>
- Enumeration for the block state.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Allowed">
- <summary>
- Value to check if the app is allowed to post notification.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Blocked">
- <summary>
- Value to check if the app is not allowed to post any notification.
- </summary>
- </member>
- <member name="F:Tizen.Applications.Notifications.NotificationBlockState.DoNotDisturb">
- <summary>
- Value to check if the do not disturb mode is set by the user.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Notifications.NotificationManager">
- <summary>
- NotificationManager class to post, update, delete, and get notification.
- </summary>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.Post(Tizen.Applications.Notifications.Notification)">
- <summary>
- Posts a new notification.
- </summary>
- <param name="notification">Notification to post.</param>
- <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "first notification"
- };
-
- Notification.AccessorySet accessory = new Notification.AccessorySet
- {
- SoundOption = AccessoryOption.On,
- CanVibrate = true
- };
- notification.Accessory = accessory;
-
- // do something
-
- NotificationManager.Post(notification);
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.Update(Tizen.Applications.Notifications.Notification)">
- <summary>
- Updates a posted notification.
- </summary>
- <param name="notification">Notification to update.</param>
- <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <example>
- <code>
- string tag = "first tag";
-
- Notification notification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = tag
- };
-
- Notification.AccessorySet accessory = new Notification.AccessorySet
- {
- LedOption = AccessoryOption.On,
- VibrationOption = AccessoryOption.Custom,
- VibrationPath = "vibration absolute path"
- }
- notification.Accessory = accessory;
-
- NotificationManager.Post(notification);
-
- // do something
-
- Notification loadNotification = NotificationManager.Load(tag);
-
- loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0);
-
- Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress));
- thread.IsBackground = true;
- thread.Start(notification);
-
- ...
-
- static void UpdateProgress(Object obj)
- {
- Notification notification = (Notification)obj;
-
- for (double current = 1.0; current <= 100.0; current = current + 1.0)
- {
- notification.Progress.ProgressCurrent = current;
- NotificationManager.Update(notification);
- Thread.Sleep(300);
- }
- }
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- <pre>
- Post method should be called on the notification object.
- </pre>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.Delete(Tizen.Applications.Notifications.Notification)">
- <summary>
- Deletes a posted notification.
- </summary>
- <param name="notification">Notification to remove.</param>
- <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "first notification"
- };
- NotificationManager.Post(notification);
-
- // do something
-
- NotificationManager.Delete(notification);
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- <pre>
- Post method should be called on the notification object.
- </pre>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.DeleteAll">
- <summary>
- Removes all posted notifications of calling application.
- </summary>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <example>
- <code>
- Notification firstNotification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "first notification"
- };
- NotificationManager.Post(firstNotification);
-
- Notification secondNotification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "second notification"
- };
- NotificationManager.Post(secondNotification);
- NotificationManager.DeleteAll();
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.Load(System.String)">
- <summary>
- Searches for a posted notification which has the specified tag and has not been deleted yet.
- </summary>
- <remarks>
- Load method should be called only for notifications, which have been posted using the NotificationManager.Post method.
- If two or more notifications share the same tag, the notification posted most recently is returned.
- </remarks>
- <param name="tag">Tag used to query.</param>
- <returns>Notification Object with specified tag.</returns>
- <exception cref="T:System.ArgumentException">Throwing the same exception when argument is invalid and when the tag does not exist is misleading.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "first notification"
- };
- NotificationManager.Post(notification);
-
- // do someting
-
- Notification loadNotification = NotificationManager.Load("first notification");
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.SaveTemplate(Tizen.Applications.Notifications.Notification,System.String)">
- <summary>
- Saves a notification template to the notification database.
- </summary>
- <param name="notification">Notification to save as template.</param>
- <param name="name">Template name.</param>
- <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when it can't be saved as a template.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "first notification"
- };
-
- Notification.Accessory accessory = new Notification.Accessory
- {
- LedOption = AccessoryOption.On,
- VibrationOption = AccessoryOption.Custom,
- VibrationPath = "vibration absolute path"
- }
- notification.setAccessory(accessory);
-
- // do something
-
- NotificationManager.Post(notification);
-
- Notification.LockStyle style = new Notification.LockStyle
- {
- IconPath = "icon path",
- ThumbnailPath = "Thumbnail path"
- }
- notification.AddStyle(style);
- NotificationManager.SaveTemplate(notification, "firstTemplate");
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.LoadTemplate(System.String)">
- <summary>
- Loads a notification template from the notification database.
- </summary>
- <param name="name">Template name.</param>
- <returns>Notification Object with inputted template name.</returns>
- <exception cref="T:System.ArgumentException">Throwing the same exception when argument is invalid and when the template does not exist is misleading.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <example>
- <code>
- Notification notification = new Notification
- {
- Title = "title",
- Content = "content",
- Icon = "absolute icon path",
- Tag = "first notification"
- };
-
- Notification.Accessory accessory = new Notification.Accessory
- {
- LedOption = AccessoryOption.On,
- VibrationOption = AccessoryOption.Custom,
- VibrationPath = "vibration absolute path"
- }
- notification.setAccessory(accessory);
-
- // do something
-
- NotificationManager.Post(notification);
-
- Notification.LockStyle style = new Notification.LockStyle
- {
- IconPath = "icon path",
- ThumbnailPath = "Thumbnail path"
- }
- notification.AddStyle(style);
- NotificationManager.SaveTemplate(notification, "firstTemplate");
- Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate");
- </code>
- </example>
- <privilege>http://tizen.org/privilege/notification</privilege>
- </member>
- <member name="M:Tizen.Applications.Notifications.NotificationManager.GetBlockState">
- <summary>
- Gets notification block state.
- </summary>
- <remarks>
- The user can set the notification block state in settings.
- The block state indicates whether or not notifications can be posted.
- Additionally, only notifications to the notification panel are allowed in "Do not disturb mode".
- Sound, vibrate, and active notifications are blocked.
- </remarks>
- <returns>NotificationBlockState is a state if notification is posted.</returns>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>
- <privilege>http://tizen.org/privilege/notification</privilege>
- </member>
- <member name="P:Tizen.Applications.Notifications.NotificationSafeHandle.IsInvalid">
- <summary>
- Gets a value that indicates whether the handle is invalid.
- </summary>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.Applications.Notification</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Tizen.Applications.Notifications.Notification">\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ The class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ <summary>\r
+ This class contains common properties and methods of notifications.\r
+ </summary>\r
+ <remarks>\r
+ A notification is a message that is displayed on the notification area.\r
+ It is created to notify information to the user through the application.\r
+ This class helps you to provide method and property for creating notification object.\r
+ </remarks>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Tag">\r
+ <summary>\r
+ Gets or sets the tag of notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Title">\r
+ <summary>\r
+ Gets or sets the title of notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Icon">\r
+ <summary>\r
+ Gets or sets the icon of notification.\r
+ You should set an absolute path for an image file.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.SubIcon">\r
+ <summary>\r
+ Gets or sets the sub icon of notification.\r
+ This SubIcon is displayed in Icon you set.\r
+ You should set an absolute path for an image file.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Content">\r
+ <summary>\r
+ Gets or sets the content of notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.IsTimeStampVisible">\r
+ <summary>\r
+ Gets or sets a value indicating whether TimeStamp of the notification is Visible or not.\r
+ Default to true.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.TimeStamp">\r
+ <summary>\r
+ Gets or sets the TimeStamp of notification.\r
+ </summary>\r
+ <remarks>\r
+ If you don't set TimeStamp, it will set the value when the notification is posted.\r
+ TimeStamp requires NotificationManager.Post() to be called.\r
+ If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Action">\r
+ <summary>\r
+ Gets or sets action, which is invoked when the notification is clicked.\r
+ </summary>\r
+ <remarks>\r
+ If you set it to null, the already set AppControl will be removed and nothing will happen when you click on notification.\r
+ </remarks>\r
+ <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Count">\r
+ <summary>\r
+ Gets or sets count, which is displayed at the right side of the notification.\r
+ </summary>\r
+ <remarks>\r
+ You must set only positive number.\r
+ If you set count to negative number, this property throws exception.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Property">\r
+ <summary>\r
+ Gets or sets property.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Applications.Notifications.NotificationProperty"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Progress">\r
+ <summary>\r
+ Gets or sets <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> object for display at notification.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Applications.Notifications.Notification.ProgressType"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Accessory">\r
+ <summary>\r
+ 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
+ </summary>\r
+ <remarks>\r
+ If you set it to null, the already set AccessorySet will be initialized.\r
+ </remarks>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "Notification",\r
+ Content = "Hello Tizen",\r
+ Icon = "Icon path",\r
+ Count = 3\r
+ };\r
+ \r
+ Notification.AccessorySet accessory = new Notification.AccessorySet\r
+ {\r
+ SoundOption = AccessoryOption.Custom,\r
+ SoundPath = "Sound File Path",\r
+ IsVibration = true,\r
+ LedOption = AccessoryOption.Custom,\r
+ LedOnMs = 100;\r
+ LedOffMs = 50;\r
+ LedColor = Color.Lime\r
+ };\r
+ \r
+ notification.Accessory = accessory;\r
+ \r
+ NotificationManager.Post(notification);\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.IsVisible">\r
+ <summary>\r
+ Gets or sets a value indicating whether notification is displayed on the default viewer.\r
+ If you set false and add style, you can see only style notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.Handle">\r
+ <summary>\r
+ Gets or sets NotificationSafeHandle.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.PrivID">\r
+ <summary>\r
+ Gets or sets private ID.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.AddStyle(Tizen.Applications.Notifications.Notification.StyleBase)">\r
+ <summary>\r
+ Method for adding various styles to be applied to notification.\r
+ </summary>\r
+ <remarks>\r
+ The user always see about valid notification style. If you add a style which is not supported in platform,\r
+ this method has no effect.\r
+ </remarks>\r
+ <param name="style">The style to be applied to notification.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "Notification",\r
+ Content = "Hello Tizen",\r
+ Icon = "Icon path",\r
+ Count = 3\r
+ };\r
+ \r
+ Notification.LockStyle lockStyle = new Notification.LockStyle\r
+ {\r
+ IconPath = "Icon path",\r
+ ThumbnailPath = "Thumbnail Path"\r
+ };\r
+ \r
+ notification.AddStyle(lockStyle);\r
+ \r
+ NotificationManager.Post(notification);\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.RemoveStyle``1">\r
+ <summary>\r
+ Method to remove style you already added.\r
+ </summary>\r
+ <typeparam name="T">Type of notification style to be queried.</typeparam>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.GetStyle``1">\r
+ <summary>\r
+ Method to get style you already added.\r
+ </summary>\r
+ <typeparam name="T">Type of notification style to be queried.</typeparam>\r
+ <returns>\r
+ The Notification.Style object associated with the given style.\r
+ </returns>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.SetExtraData(System.String,Tizen.Applications.Bundle)">\r
+ <summary>\r
+ Method to set extra data to add extra data.\r
+ </summary>\r
+ <remarks>\r
+ The type of extra data is bundle.\r
+ </remarks>\r
+ <param name="key">The key of the extra data you want to add.</param>\r
+ <param name="value">The value you want to add.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "Notification",\r
+ Content = "Hello Tizen",\r
+ Icon = "Icon path",\r
+ };\r
+ \r
+ Bundle bundle = new Bundle();\r
+ bundle.AddItem("key", "value");\r
+ \r
+ notification.SetExtraData("firstKey", bundle);\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.RemoveExtraData(System.String)">\r
+ <summary>\r
+ Method to remove extra you already added.\r
+ </summary>\r
+ <remarks>\r
+ The type of extra data is bundle.\r
+ </remarks>\r
+ <param name="key">The key of the extra data to add.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.GetExtraData(System.String)">\r
+ <summary>\r
+ Method to get extra data you already set.\r
+ </summary>\r
+ <param name="key">The key of the extra data to get.</param>\r
+ <returns>Bundle Object that include extra data</returns>\r
+ <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.Dispose">\r
+ <summary>\r
+ Releases any unmanaged resources used by this object.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.AccessorySet">\r
+ <summary>\r
+ Class for notification AccessorySet, which includes vibration, LED, and sound option.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundOption">\r
+ <summary>\r
+ Gets or sets the sound option. Default to AccessoryOption.Off.\r
+ </summary>\r
+ <remarks>\r
+ If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.SoundPath">\r
+ <summary>\r
+ Gets or sets the sound path, It will play on the sound file you set.\r
+ You should set an absolute path for a sound file.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.CanVibrate">\r
+ <summary>\r
+ Gets or sets a value indicating whether vibration is operated. Default is false.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOption">\r
+ <summary>\r
+ Gets or sets the led option. The default value is AccessoryOption.Off.\r
+ </summary>\r
+ <remarks>\r
+ If you set AccessoryOption.Custom and not set LedColor, the LED will show default color.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOnMillisecond">\r
+ <summary>\r
+ Gets or sets the on time so that it looks like the device's LED is blinking.\r
+ </summary>\r
+ <remarks>\r
+ Default value of LedOnMillisecond is 0.\r
+ The rate is specified in terms of the number of Milliseconds to be on.\r
+ You must set the on and off times at the same time. Otherwise, it may not operate normally.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedOffMillisecond">\r
+ <summary>\r
+ Gets or sets the off time so that it looks like the device's LED is blinking.\r
+ </summary>\r
+ <remarks>\r
+ The rate is specified in terms of the number of Milliseconds to be off.\r
+ You must set the on and off times at the same time. Otherwise, it may not operate normally.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.AccessorySet.LedColor">\r
+ <summary>\r
+ Gets or sets the LED color that you would like the LED on the device to blink.\r
+ </summary>\r
+ <remarks>\r
+ If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color.\r
+ </remarks>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.ActiveStyle">\r
+ <summary>\r
+ Class for generating active style notification.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ActiveStyle"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.BackgroundImage">\r
+ <summary>\r
+ Gets or sets an absolute path for an image file to display on the background of active notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.IsAutoRemove">\r
+ <summary>\r
+ Gets or sets a value indicating whether the active notification is removed automatically. Default value is true.\r
+ </summary>\r
+ <remarks>\r
+ IsAutoRemove option lets the active notification to be removed several seconds after it shows.\r
+ When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes\r
+ it or the application, which posted the active notification.\r
+ </remarks>>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.DefaultButton">\r
+ <summary>\r
+ Gets or sets the default button to display highlight on the active notification.\r
+ </summary>\r
+ <remarks>\r
+ The default button for display highlight is only reflected on the Tizen TV.\r
+ If you use this property on other profile, this value has no effect.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.ReplyAction">\r
+ <summary>\r
+ Gets or sets a ReplyAction to this active notification style.\r
+ </summary>\r
+ <remarks>\r
+ When you add a ReplyAction to the ActiveStyle, the notification UI will show a ReplyAction with button.\r
+ If you set null parameter, ReplyAction is not displayed.\r
+ </remarks>\r
+ <example>\r
+ <code>\r
+ \r
+ ButtonAction button = new ButtonAction\r
+ {\r
+ Index = ButtonIndex.First,\r
+ Text = "Yes"\r
+ Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
+ };\r
+ \r
+ ReplyAction reply = new ReplyAction\r
+ {\r
+ ParentIndex = ButtonIndex.First;\r
+ PlaceHolderText = "Please write your reply."\r
+ ReplyMax = 160,\r
+ Button = new ButtonAction\r
+ {\r
+ Text = "Yes",\r
+ ImagePath = "image path"\r
+ Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
+ };\r
+ };\r
+ \r
+ ActiveStyle active = new ActiveStyle\r
+ {\r
+ AutoRemove = true,\r
+ BackgroundImage = "image path",\r
+ ReplyAction = reply\r
+ };\r
+ \r
+ active.AddButtonAction(button);\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByUserAction">\r
+ <summary>\r
+ Gets or sets Action which is invoked when notification is hidden by user.\r
+ </summary>\r
+ <remarks>\r
+ If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by user.\r
+ The property is only reflected on Tizen TV.\r
+ If you use this API on other profile, this action have no effect\r
+ </remarks>\r
+ <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByTimeoutAction">\r
+ <summary>\r
+ Gets or sets Action which is invoked when there is no any response by user until hide timeout.\r
+ </summary>\r
+ <remarks>\r
+ This action occurs when there is no response to the notification until the delete timeout set by SetRemoveTime().\r
+ If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by timeout.\r
+ The property is only reflected on Tizen TV.\r
+ If you use this API on other profile, this action settings have no effect\r
+ </remarks>\r
+ <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.HiddenByExternalAction">\r
+ <summary>\r
+ Gets or sets Action which is invoked when the notification is hidden by external factor.\r
+ </summary>\r
+ <remarks>\r
+ 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
+ The property is only reflected on Tizen TV.\r
+ If you use this API on other profile, this action settings have no effect\r
+ </remarks>\r
+ <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ActiveStyle.Key">\r
+ <summary>\r
+ Gets the key of ActiveStyle.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.SetRemoveTime(System.Int32,System.Int32)">\r
+ <summary>\r
+ Method to set time to hide or delete notification.\r
+ </summary>\r
+ <remarks>\r
+ The time settings for hiding and deleting are only reflected on the Tizen TV.\r
+ If you use this API on other profile, this time settings have no effect.\r
+ </remarks>\r
+ <param name="hideTime">The value in seconds when the notification can be hidden from the notification viewer after the notification is posted.</param>\r
+ <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
+ <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetRemoveTime(System.Int32@,System.Int32@)">\r
+ <summary>\r
+ Method to get time set to hide or delete notification.\r
+ </summary>\r
+ <param name="hideTime">The value in seconds when the notification can be hidden from the notification viewer after notification is posted.</param>\r
+ <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
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.AddButtonAction(Tizen.Applications.Notifications.Notification.ButtonAction)">\r
+ <summary>\r
+ Method to add a button to the active notification style.\r
+ Buttons are displayed on the notification.\r
+ </summary>\r
+ <remarks>\r
+ If you add button that has same index, the button is replaced to latest adding button.\r
+ If you don't set an index on ButtonAction, the index is set sequentially from zero.\r
+ </remarks>\r
+ <param name="button">A ButtonAction for appear to the notification.</param>\r
+ <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>\r
+ <example>\r
+ <code>\r
+ \r
+ ButtonAction button = new ButtonAction\r
+ {\r
+ Index = 0,\r
+ Text = "Yes"\r
+ Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
+ };\r
+ \r
+ ActiveStyle active = new ActiveStyle\r
+ {\r
+ IsAutoRemove = true,\r
+ BackgroundImage = "image path",\r
+ };\r
+ \r
+ active.AddButtonAction(button);\r
+ \r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.RemoveButtonAction(Tizen.Applications.Notifications.ButtonIndex)">\r
+ <summary>\r
+ Removes the ButtonAction you already added.\r
+ </summary>\r
+ <param name="index">The index to remove a button.</param>\r
+ <returns>true if the element is successfully found and removed; otherwise, false.</returns>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ActiveStyle.GetButtonAction(Tizen.Applications.Notifications.ButtonIndex)">\r
+ <summary>\r
+ Gets the ButtonAction of the active notification.\r
+ </summary>\r
+ <param name="index">The index to get a button you already added.</param>\r
+ <returns>The ButtonAction object, which you already added.</returns>\r
+ <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.ButtonAction">\r
+ <summary>\r
+ This class helps you to set the button on active style of notification.\r
+ </summary>\r
+ <remarks>\r
+ It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button.\r
+ </remarks>>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Index">\r
+ <summary>\r
+ Gets or sets the index of the button, which appeares as notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Text">\r
+ <summary>\r
+ Gets or sets the text describing the button.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.ImagePath">\r
+ <summary>\r
+ Gets or sets the image path that represents the button.\r
+ You should provide an absolute path for an image file.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ButtonAction.Action">\r
+ <summary>\r
+ Gets or sets the action, which is invoked when the button is clicked.\r
+ </summary>\r
+ <value>\r
+ If you don't set action, nothing happens when the button is clicked.\r
+ </value>\r
+ <example>\r
+ <code>\r
+ ButtonAction button = new ButtonAction\r
+ {\r
+ Index = ButtonIndex.First,\r
+ text = "Yes",\r
+ ImagePath = "image path",\r
+ Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
+ };\r
+ </code>\r
+ </example>\r
+ <seealso cref="T:Tizen.Applications.AppControl"></seealso>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.IndicatorStyle">\r
+ <summary>\r
+ Class for generating indicator style notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.IconPath">\r
+ <summary>\r
+ Gets or sets an absolute path for an image file.\r
+ If you set IconPath, you can see the icon on the right side of indicator.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.SubText">\r
+ <summary>\r
+ Gets or sets a sub text for displaying indicator style.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.IndicatorStyle.Key">\r
+ <summary>\r
+ Gets the key of IndicatorStyle.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.LockStyle">\r
+ <summary>\r
+ Class for generating lock style notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.IconPath">\r
+ <summary>\r
+ Gets or sets an absolute path for an image file to display the icon of lock style.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.ThumbnailPath">\r
+ <summary>\r
+ Gets or sets an absolute path for a thumbnail image file to display on lock style.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.LockStyle.Key">\r
+ <summary>\r
+ Gets the key of LockStyle.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.MakerBase">\r
+ <summary>\r
+ An object that helps notification to make to SafeHandle.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.ProgressType">\r
+ <summary>\r
+ Class for displaying progress notification.\r
+ You must initialize progress category, current, and max value when you create an object.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.Notification.ProgressType.#ctor(Tizen.Applications.Notifications.ProgressCategory,System.Double,System.Double)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Tizen.Applications.Notifications.Notification.ProgressType"/> class.\r
+ You must initialize category, current, and max value of the progress.\r
+ </summary>\r
+ <param name="category">The category of progress that appeared on notification.</param>\r
+ <param name="current">The current value of the progress.</param>\r
+ <param name="max">The max value of the progress.</param>\r
+ <exception cref="!:ArgumentException">Thrown when an argument is invalid.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.Category">\r
+ <summary>\r
+ Gets or sets category of ProgressType.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Applications.Notifications.ProgressCategory"></seealso>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressCurrent">\r
+ <summary>\r
+ Gets or sets current value of ProgressType.\r
+ </summary>\r
+ <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ProgressType.ProgressMax">\r
+ <summary>\r
+ Gets or sets max value of ProgressType.\r
+ </summary>\r
+ <exception cref="!:ArgumentException">Thrown when argument is invalid.</exception>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.ReplyAction">\r
+ <summary>\r
+ Class for displaying direct-reply on notification.\r
+ You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ParentIndex">\r
+ <summary>\r
+ Gets or sets the index of button, which appears at notification.\r
+ If you set ParentIndex, ReplyAction is displayed when button matches with ParentIndex that is clicked by the user.\r
+ If you don't set ParentIndex, it appears as notification directly.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.PlaceHolderText">\r
+ <summary>\r
+ Gets or sets the PlaceHolderText of ReplyAction which appears at notification.\r
+ If you set PlaceHolderText, it is displayed to placeholder in notification.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.ReplyMax">\r
+ <summary>\r
+ Gets or sets the maximum number of characters that the user can input.\r
+ You must set a ReplyMax. Otherwise user don't write text to placeholder in notification.\r
+ </summary>\r
+ <value>\r
+ Default value is 160.\r
+ </value>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.Notification.ReplyAction.Button">\r
+ <summary>\r
+ Gets or sets the button, which appears as ReplyAction in notification.\r
+ You must set the button, otherwise, a user can't send written text to application, which is set by AppControl.\r
+ </summary>\r
+ <remarks>\r
+ If you set it to null, the already set ButtonAction will be removed.\r
+ </remarks>\r
+ <example>\r
+ <code>\r
+ ReplyAction button = new ReplyAction\r
+ {\r
+ ParentIndex = ButtonIndex.Second;\r
+ PlaceHolderText = "Please write your reply."\r
+ ReplyMax = 160,\r
+ Button = new ButtonAction\r
+ {\r
+ text = "Yes",\r
+ ImagePath = "image path",\r
+ Action = new AppControl{ ApplicationId = "org.tizen.app" };\r
+ };\r
+ };\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.Notification.StyleBase">\r
+ <summary>\r
+ An object can apply a rich notification style to a notification object.\r
+ If the platform does not provide rich notification, styles in this class have no effect.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.ProgressCategory">\r
+ <summary>\r
+ Enumeration for the progress category.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ProgressCategory.Percent">\r
+ <summary>\r
+ Value for percent type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ProgressCategory.Time">\r
+ <summary>\r
+ Value for time type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ProgressCategory.PendingBar">\r
+ <summary>\r
+ Value for pending type, which is not the updated progress current value.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.AccessoryOption">\r
+ <summary>\r
+ Enumeration for the accessory option.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.AccessoryOption.Off">\r
+ <summary>\r
+ Value for off accessory option.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.AccessoryOption.On">\r
+ <summary>\r
+ Value for on accessory option.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.AccessoryOption.Custom">\r
+ <summary>\r
+ Value for the custom accessory option.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.ButtonIndex">\r
+ <summary>\r
+ Enumeration for the button index.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ButtonIndex.None">\r
+ <summary>\r
+ Value for the default button index.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ButtonIndex.First">\r
+ <summary>\r
+ Value for the first button index.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ButtonIndex.Second">\r
+ <summary>\r
+ Value for the second button index.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.ButtonIndex.Third">\r
+ <summary>\r
+ Value for the third button index.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.NotificationProperty">\r
+ <summary>\r
+ Enumeration for the notification particular property.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationProperty.None">\r
+ <summary>\r
+ Value for adjust nothing.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisplayOnlySimMode">\r
+ <summary>\r
+ Value for display only SIM card inserted.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAppLaunch">\r
+ <summary>\r
+ Value for disable application launch when it is selected.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationProperty.DisableAutoDelete">\r
+ <summary>\r
+ Value for disable auto delete when it is selected.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationProperty.VolatileDisplay">\r
+ <summary>\r
+ Value for deleted when device is rebooted even though notification is not set ongoing.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.NotificationBlockState">\r
+ <summary>\r
+ Enumeration for the block state.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Allowed">\r
+ <summary>\r
+ Value to check if the app is allowed to post notification.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationBlockState.Blocked">\r
+ <summary>\r
+ Value to check if the app is not allowed to post any notification.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Applications.Notifications.NotificationBlockState.DoNotDisturb">\r
+ <summary>\r
+ Value to check if the do not disturb mode is set by the user.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Notifications.NotificationManager">\r
+ <summary>\r
+ NotificationManager class to post, update, delete, and get notification.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.Post(Tizen.Applications.Notifications.Notification)">\r
+ <summary>\r
+ Posts a new notification.\r
+ </summary>\r
+ <param name="notification">Notification to post.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "first notification"\r
+ };\r
+ \r
+ Notification.AccessorySet accessory = new Notification.AccessorySet\r
+ {\r
+ SoundOption = AccessoryOption.On,\r
+ CanVibrate = true\r
+ };\r
+ notification.Accessory = accessory;\r
+ \r
+ // do something\r
+ \r
+ NotificationManager.Post(notification);\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.Update(Tizen.Applications.Notifications.Notification)">\r
+ <summary>\r
+ Updates a posted notification.\r
+ </summary>\r
+ <param name="notification">Notification to update.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <example>\r
+ <code>\r
+ string tag = "first tag";\r
+ \r
+ Notification notification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = tag\r
+ };\r
+ \r
+ Notification.AccessorySet accessory = new Notification.AccessorySet\r
+ {\r
+ LedOption = AccessoryOption.On,\r
+ VibrationOption = AccessoryOption.Custom,\r
+ VibrationPath = "vibration absolute path"\r
+ }\r
+ notification.Accessory = accessory;\r
+ \r
+ NotificationManager.Post(notification);\r
+ \r
+ // do something\r
+ \r
+ Notification loadNotification = NotificationManager.Load(tag);\r
+ \r
+ loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0);\r
+ \r
+ Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress));\r
+ thread.IsBackground = true;\r
+ thread.Start(notification);\r
+ \r
+ ...\r
+ \r
+ static void UpdateProgress(Object obj)\r
+ {\r
+ Notification notification = (Notification)obj;\r
+ \r
+ for (double current = 1.0; current <= 100.0; current = current + 1.0)\r
+ {\r
+ notification.Progress.ProgressCurrent = current;\r
+ NotificationManager.Update(notification);\r
+ Thread.Sleep(300);\r
+ }\r
+ }\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ <pre>\r
+ Post method should be called on the notification object.\r
+ </pre>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.Delete(Tizen.Applications.Notifications.Notification)">\r
+ <summary>\r
+ Deletes a posted notification.\r
+ </summary>\r
+ <param name="notification">Notification to remove.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "first notification"\r
+ };\r
+ NotificationManager.Post(notification);\r
+ \r
+ // do something\r
+ \r
+ NotificationManager.Delete(notification);\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ <pre>\r
+ Post method should be called on the notification object.\r
+ </pre>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.DeleteAll">\r
+ <summary>\r
+ Removes all posted notifications of calling application.\r
+ </summary>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <example>\r
+ <code>\r
+ Notification firstNotification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "first notification"\r
+ };\r
+ NotificationManager.Post(firstNotification);\r
+ \r
+ Notification secondNotification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "second notification"\r
+ };\r
+ NotificationManager.Post(secondNotification);\r
+ NotificationManager.DeleteAll();\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.Load(System.String)">\r
+ <summary>\r
+ Searches for a posted notification which has the specified tag and has not been deleted yet.\r
+ </summary>\r
+ <remarks>\r
+ Load method should be called only for notifications, which have been posted using the NotificationManager.Post method.\r
+ If two or more notifications share the same tag, the notification posted most recently is returned.\r
+ </remarks>\r
+ <param name="tag">Tag used to query.</param>\r
+ <returns>Notification Object with specified tag.</returns>\r
+ <exception cref="T:System.ArgumentException">Throwing the same exception when argument is invalid and when the tag does not exist is misleading.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "first notification"\r
+ };\r
+ NotificationManager.Post(notification);\r
+ \r
+ // do someting\r
+ \r
+ Notification loadNotification = NotificationManager.Load("first notification");\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.SaveTemplate(Tizen.Applications.Notifications.Notification,System.String)">\r
+ <summary>\r
+ Saves a notification template to the notification database.\r
+ </summary>\r
+ <param name="notification">Notification to save as template.</param>\r
+ <param name="name">Template name.</param>\r
+ <exception cref="T:System.ArgumentException">Thrown when an argument is invalid.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown when it can't be saved as a template.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "first notification"\r
+ };\r
+ \r
+ Notification.Accessory accessory = new Notification.Accessory\r
+ {\r
+ LedOption = AccessoryOption.On,\r
+ VibrationOption = AccessoryOption.Custom,\r
+ VibrationPath = "vibration absolute path"\r
+ }\r
+ notification.setAccessory(accessory);\r
+ \r
+ // do something\r
+ \r
+ NotificationManager.Post(notification);\r
+ \r
+ Notification.LockStyle style = new Notification.LockStyle\r
+ {\r
+ IconPath = "icon path",\r
+ ThumbnailPath = "Thumbnail path"\r
+ }\r
+ notification.AddStyle(style);\r
+ NotificationManager.SaveTemplate(notification, "firstTemplate");\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.LoadTemplate(System.String)">\r
+ <summary>\r
+ Loads a notification template from the notification database.\r
+ </summary>\r
+ <param name="name">Template name.</param>\r
+ <returns>Notification Object with inputted template name.</returns>\r
+ <exception cref="T:System.ArgumentException">Throwing the same exception when argument is invalid and when the template does not exist is misleading.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <example>\r
+ <code>\r
+ Notification notification = new Notification\r
+ {\r
+ Title = "title",\r
+ Content = "content",\r
+ Icon = "absolute icon path",\r
+ Tag = "first notification"\r
+ };\r
+ \r
+ Notification.Accessory accessory = new Notification.Accessory\r
+ {\r
+ LedOption = AccessoryOption.On,\r
+ VibrationOption = AccessoryOption.Custom,\r
+ VibrationPath = "vibration absolute path"\r
+ }\r
+ notification.setAccessory(accessory);\r
+ \r
+ // do something\r
+ \r
+ NotificationManager.Post(notification);\r
+ \r
+ Notification.LockStyle style = new Notification.LockStyle\r
+ {\r
+ IconPath = "icon path",\r
+ ThumbnailPath = "Thumbnail path"\r
+ }\r
+ notification.AddStyle(style);\r
+ NotificationManager.SaveTemplate(notification, "firstTemplate");\r
+ Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate");\r
+ </code>\r
+ </example>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Notifications.NotificationManager.GetBlockState">\r
+ <summary>\r
+ Gets notification block state.\r
+ </summary>\r
+ <remarks>\r
+ The user can set the notification block state in settings.\r
+ The block state indicates whether or not notifications can be posted.\r
+ Additionally, only notifications to the notification panel are allowed in "Do not disturb mode".\r
+ Sound, vibrate, and active notifications are blocked.\r
+ </remarks>\r
+ <returns>NotificationBlockState is a state if notification is posted.</returns>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission is denied.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
+ <privilege>http://tizen.org/privilege/notification</privilege>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Notifications.NotificationSafeHandle.IsInvalid">\r
+ <summary>\r
+ Gets a value that indicates whether the handle is invalid.\r
+ </summary>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff