/// <summary>
/// Initializes a new instance of the <see cref="Notification"/> class.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Notification()
{
styleDictionary = new Dictionary<string, StyleBase>();
/// <summary>
/// Gets or sets the tag of notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Tag { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the title of notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Title { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the icon of notification.
- /// You should set an absolute path for an image file.
+ /// You should set an absolute path for an image file.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Icon { get; set; } = string.Empty;
/// <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.
+ /// You should set an absolute path for an image file.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string SubIcon { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the content of notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Content { get; set; } = string.Empty;
/// <summary>
/// Gets or sets a value indicating whether TimeStamp of the notification is Visible or not.
/// Default to true.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool IsTimeStampVisible { get; set; } = true;
/// <summary>
/// TimeStamp requires NotificationManager.Post() to be called.
/// If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification.
/// </remarks>
+ /// <since_tizen> 3 </since_tizen>
public DateTime TimeStamp { get; set; }
/// <summary>
/// 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="Tizen.Applications.AppControl"></seealso>
+ /// <since_tizen> 3 </since_tizen>
public AppControl Action { get; set; }
/// <summary>
/// If you set count to negative number, this property throws exception.
/// </remarks>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <since_tizen> 3 </since_tizen>
public int Count
{
get
}
}
+ /// <summary>
+ /// Gets or sets a value indicating whether the notification is Onging or not.
+ /// Default value is false.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public bool IsOngoing { get; set; } = false;
/// Gets or sets property.
/// </summary>
/// <seealso cref="Tizen.Applications.Notifications.NotificationProperty"></seealso>
+ /// <since_tizen> 3 </since_tizen>
public NotificationProperty Property { get; set; } = NotificationProperty.None;
/// <summary>
/// Gets or sets <see cref="Notification.ProgressType"/> object for display at notification.
/// </summary>
/// <seealso cref="Tizen.Applications.Notifications.Notification.ProgressType"></seealso>
+ /// <since_tizen> 3 </since_tizen>
public ProgressType Progress { get; set; }
/// <summary>
/// {
/// SoundOption = AccessoryOption.Custom,
/// SoundPath = "Sound File Path",
- /// IsVibration = true,
+ /// CanVibrate = true,
/// LedOption = AccessoryOption.Custom,
- /// LedOnMs = 100;
- /// LedOffMs = 50;
- /// LedColor = Color.Lime
+ /// LedOnMillisecond = 100,
+ /// LedOffMillisecond = 50,
+ /// LedColor = Tizen.Common.Color.Lime
/// };
///
/// notification.Accessory = accessory;
/// NotificationManager.Post(notification);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public AccessorySet Accessory { get; set; }
/// <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>
+ /// <since_tizen> 4 </since_tizen>
public bool IsVisible { get; set; } = true;
/// <summary>
+ /// Gets a flag for do not show again checkbox.
+ /// </summary>
+ /// <since_tizen> 11 </since_tizen>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool CheckBox { get; set; } = false;
+
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool CheckedValue { get; set; } = false;
+
+ /// <summary>
/// Gets or sets NotificationSafeHandle.
/// </summary>
internal NotificationSafeHandle Handle
/// NotificationManager.Post(notification);
/// </code>
/// </example>
+ /// <since_tizen> 3 </since_tizen>
public void AddStyle(StyleBase style)
{
if (style == null)
/// </summary>
/// <typeparam name="T">Type of notification style to be queried.</typeparam>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveStyle<T>() where T : Notification.StyleBase, new()
{
T type = new T();
/// The Notification.Style object associated with the given style.
/// </returns>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <since_tizen> 3 </since_tizen>
public T GetStyle<T>() where T : Notification.StyleBase, new()
{
T type = new T();
/// notification.SetExtraData("firstKey", bundle);
/// </code>
/// </example>
+ /// <since_tizen> 4 </since_tizen>
public void SetExtraData(string key, Bundle value)
{
if (value == null || value.SafeBundleHandle.IsInvalid || string.IsNullOrEmpty(key))
/// </remarks>
/// <param name="key">The key of the extra data to add.</param>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <since_tizen> 4 </since_tizen>
public void RemoveExtraData(string key)
{
if (string.IsNullOrEmpty(key))
/// <param name="key">The key of the extra data to get.</param>
/// <returns>Bundle Object that include extra data</returns>
/// <exception cref="ArgumentException">Thrown when argument is invalid.</exception>
+ /// <since_tizen> 4 </since_tizen>
public Bundle GetExtraData(string key)
{
if (string.IsNullOrEmpty(key))
/// <summary>
/// Releases any unmanaged resources used by this object.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
foreach (string key in GetextraDataDictionary().Keys)
{
Log.Info(LogTag, "Start to bind Notification.ExtenderData to SafeHandle");
- Interop.Notification.SetExtentionData(Handle, key, extraDataDictionary[key].SafeBundleHandle);
+ Interop.Notification.SetExtensionData(Handle, key, extraDataDictionary[key].SafeBundleHandle);
}
foreach (Notification.StyleBase style in styleDictionary.Values)
internal Notification Build()
{
- IntPtr extention = IntPtr.Zero;
- IntPtr extentionBundlePtr = IntPtr.Zero;
+ IntPtr extension = IntPtr.Zero;
+ IntPtr extensionBundlePtr = IntPtr.Zero;
NotificationBinder.BindSafeHandle(this);
- Interop.Notification.GetExtentionBundle(Handle, out extention, out extentionBundlePtr);
+ Interop.Notification.GetExtensionBundle(Handle, out extension, out extensionBundlePtr);
- if (extention != IntPtr.Zero)
+ if (extension != IntPtr.Zero)
{
- Bundle bundle = new Bundle(new SafeBundleHandle(extention, false));
+ Bundle bundle = new Bundle(new SafeBundleHandle(extension, false));
foreach (string key in bundle.Keys)
{
if (key.StartsWith("_NOTIFICATION_EXTENSION_EVENT_"))
continue;
SafeBundleHandle sbh;
- Interop.Notification.GetExtentionData(Handle, key, out sbh);
+ Interop.Notification.GetExtensionData(Handle, key, out sbh);
extraDataDictionary.Add(key, new Bundle(sbh));
}
}