/// <summary>
/// Gets the unique number of the Notification.
/// </summary>
- /// <example>
- /// <code>
- /// int uniqueNumber = NotificationDeleteEventArgs.UniqueNumber;
- /// </code>
- /// </example>
public int UniqueNumber { get; internal set; }
}
}
/// <summary>
/// Gets the unique id of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// int uniqueNumber = NotificationEventArgs.UniqueNumber;
- /// </code>
- /// </example>
public int UniqueNumber { get; internal set; }
/// <summary>
/// Gets the appId of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// string appId = NotificationEventArgs.AppID;
- /// </code>
- /// </example>
public string AppID { get; internal set; }
/// <summary>
/// Gets the title of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// string title = NotificationEventArgs.Title;
- /// </code>
- /// </example>
public string Title { get; internal set; }
/// <summary>
/// Gets the content text of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// string content = NotificationEventArgs.Content;
- /// </code>
- /// </example>
public string Content { get; internal set; }
/// <summary>
/// Gets the icon's path of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// string icon = NotificationEventArgs.Icon;
- /// </code>
- /// </example>
public string Icon { get; internal set; }
/// <summary>
/// Gets the sub icon path of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// string subIcon = NotificationEventArgs.SubIcon;
- /// </code>
- /// </example>
public string SubIcon { get; internal set; }
/// <summary>
public bool IsTimeStampVisible { get; internal set; }
/// <summary>
- /// Gets time of Notification.
+ /// Gets TimeStamp of Notification.
/// </summary>
- /// <example>
- /// <code>
- /// DateTime timeStamp = NotificationEventArgs.TimeStamp;
- /// </code>
- /// </example>
+ /// <remarks>
+ /// If IsTimeStampVisible property is set false, this TimeStamp property is meanless.
+ /// </remarks>
public DateTime TimeStamp { get; internal set; }
/// <summary>
/// Gets the count which is displayed at the right side of notification.
/// </summary>
- /// <example>
- /// <code>
- /// int count = NotificationEventArgs.Count;
- /// </code>
- /// </example>
public int Count { get; internal set; }
/// <summary>
/// Gets the Tag of notification.
/// </summary>
- /// <example>
- /// <code>
- /// string tag = NotificationEventArgs.Tag;
- /// </code>
- /// </example>
public string Tag { get; internal set; }
- /// <summary>
- /// Gets a value to check if it is an ongoing type.
- /// </summary>
- /// <example>
- /// <code>
- /// bool isongoing = NotificationEventArgs.IsOngoing;
- /// </code>
- /// </example>
[EditorBrowsable(EditorBrowsableState.Never)]
public bool IsOngoing { get; internal set; } = false;
/// <summary>
/// Gets a value that determines whether notification is displayed on the default viewer.
- /// If you set false and add style, you can see only style notification.
+ /// If IsDisplay property set false and add style, you can see only style notification.
/// </summary>
- /// <example>
- /// <code>
- /// bool isDisplay = NotificationEventArgs.IsDisplay;
- /// </code>
- /// </example>
public bool IsDisplay { get; internal set; } = true;
- /// <summary>
- /// Gets the event flag.
- /// </summary>
- /// <example>
- /// <code>
- /// bool eventFlag = NotificationEventArgs.HasEventFlag;
- /// </code>
- /// </example>
[EditorBrowsable(EditorBrowsableState.Never)]
public bool HasEventFlag { get; internal set; } = false;
/// <summary>
/// Gets the AppControl which is invoked when notification is clicked.
/// </summary>
- /// <example>
- /// <code>
- /// AppControl action = NotificationEventArgs.Action;
- /// </code>
- /// </example>
public AppControl Action { get; internal set; }
/// <summary>
/// Gets the object of the progress notification.
/// </summary>
- /// <example>
- /// <code>
- /// ProgressCategory category = NotificationEventArgs.Progress.Category;
- /// double current = NotificationEventArgs.Progress.Current;
- /// double max = NotificationEventArgs.Progress.Max;
- /// </code>
- /// </example>
public ProgressArgs Progress { get; internal set; }
/// <summary>
/// Gets the AccessoryArgs which has option of Sound, Vibration, LED.
/// </summary>
- /// <example>
- /// <code>
- /// string soundPath = NotificationEventArgs.Accessory.SountPath;
- /// </code>
- /// </example>
public AccessoryArgs Accessory { get; internal set; }
/// <summary>
/// Gets the key for extender.
/// </summary>
- /// <example>
- /// <code>
- /// ICollection<string> extenderkey = NotificationEventArgs.ExtenderKey;
- /// foreach (string key in extenderkey)
- /// {
- /// ...
- /// }
- /// </code>
- /// </example>
public ICollection<string> ExtenderKey
{
get
/// <summary>
/// Gets the property.
/// </summary>
- /// <example>
- /// <code>
- /// int property = NotificationEventArgs.Property;
- /// </code>
- /// </example>
public NotificationProperty Property { get; internal set; }
/// <summary>
/// Gets the styleArgs of active, lock, indicator, bigpicture.
/// </summary>
/// <typeparam name="T">Type of notification style to be queried</typeparam>
- /// <returns>The Notification.Style object associated with the given style</returns>
+ /// <returns>The NotificationEventListener.StyleArgs object associated with the given style</returns>
/// <exception cref="ArgumentException">Thrown when argument is invalid</exception>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// autoremove = style.IsAutoRemove;
- /// </code>
- /// </example>
public T GetStyle<T>() where T : StyleArgs, new()
{
T type = new T();
/// </summary>
/// <param name="key">The key that specifies which extender</param>
/// <returns>Returns the bundle for key</returns>
- /// <exception cref="ArgumentException">Thrown when argument is invalid</exception>
- /// <example>
- /// <code>
- /// Bundle extender = NotificationEventArgs.GetExtender("key");
- /// </code>
- /// </example>
public Bundle GetExtender(string key)
{
Bundle bundle;
public partial class NotificationEventArgs
{
/// <summary>
- /// Class for Notification AccessorySet which is included vibration, led, sound option
+ /// Class to get infomation about Notification accessory.
/// </summary>
public class AccessoryArgs
{
/// <summary>
/// Gets the sound option.
/// </summary>
- /// <example>
- /// <code>
- /// AccessoryOption vibrationOption = NotificationEventArgs.Accessory.SoundOption;
- /// </code>
- /// </example>
public AccessoryOption SoundOption { get; internal set; }
/// <summary>
/// Gets the sound path.
/// </summary>
- /// <example>
- /// <code>
- /// string soundPath = NotificationEventArgs.Accessory.SountPath;
- /// </code>
- /// </example>
public string SountPath { get; internal set; }
/// <summary>
/// Gets the vibration option.
/// </summary>
- /// <example>
- /// <code>
- /// bool vibrationOption = NotificationEventArgs.Accessory.CanVibrate;
- /// </code>
- /// </example>
public bool CanVibrate { get; internal set; }
/// <summary>
/// Gets the led option.
/// </summary>
- /// <example>
- /// <code>
- /// AccessoryOption ledOption = NotificationEventArgs.Accessory.LedOption;
- /// </code>
- /// </example>
public AccessoryOption LedOption { get; internal set; }
/// <summary>
/// <value>
/// Default value of LedOnMilliseconds is 0.
/// The rate is specified in terms of the number of milliseconds to be on.
- /// You should always set the LedOnMillisecond and LedOffMillisecond. Otherwise, it may not operate normally.
/// </value>
- /// <example>
- /// <code>
- /// int ledOnMillisecond = NotificationEventArgs.Accessory.LedOnMillisecond;
- /// </code>
- /// </example>
public int LedOnMillisecond { get; internal set; }
/// <summary>
/// <value>
/// Default value of LedOffMillisecond is 0.
/// The rate is specified in terms of the number of millisecond to be off.
- /// You should always set the LedOnMillisecond and LedOffMillisecond. Otherwise, it may not operate normally.
/// </value>
- /// <example>
- /// <code>
- /// int ledOffMillisecond = NotificationEventArgs.Accessory.LedOffMillisecond;
- /// </code>
- /// </example>
public int LedOffMillisecond { get; internal set; }
/// <summary>
/// Gets led color that you would like the LED on the device to blink.
/// </summary>
- /// <example>
- /// <code>
- /// Color ledColor = NotificationEventArgs.Accessory.LedColor;
- /// </code>
- /// </example>
public Color LedColor { get; internal set; }
}
}
public partial class NotificationEventArgs
{
/// <summary>
- /// Class to generate the Active style notification
+ /// Class to get infomation about Notification Active style.
/// </summary>
public class ActiveStyleArgs : StyleArgs
{
/// When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes
/// the active notification or the app which posted the active notification removes the active notification.
/// </value>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// bool isAutoRemove = style.IsAutoRemove;
- /// </code>
- /// </example>
public bool IsAutoRemove { get; internal set; }
/// <summary>
/// Gets an absolute path for an image file to display on the background of active notification.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// string path = style.BackgroundImage;
- /// </code>
- /// </example>
public string BackgroundImage { get; internal set; }
/// <summary>
/// Gets timeout value in second when the notification can be hidden from the viewer.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// int hideTimeout = style.HideTimeout;
- /// </code>
- /// </example>
public int HideTimeout { get; internal set; }
/// <summary>
/// Gets timeout value in second when the notification can be deleted from the viewer.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// int deleteTimeout = style.DeleteTimeout;
- /// </code>
- /// </example>
public int DeleteTimeout { get; internal set; }
/// <summary>
/// Gets a button to this active notification style.
/// Buttons are displayed in the notification content.
/// </summary>
- /// <example>
- /// <code>
- /// IList<ButtonActionArgs> button = NotificationEventArgs.ActiveStyleArgs.Button;
- /// </code>
- /// </example>
public IList<ButtonActionArgs> Button { get; internal set; }
/// <summary>
- /// Gets a button to this active notification style.
- /// Buttons are displayed in the notification content.
+ /// Gets a ReplyAction to this active notification style.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// ReplyActionArgs reply = style.Replay;
- /// </code>
- /// </example>
public ReplyActionArgs Reply { get; internal set; }
internal override string Key
public partial class NotificationEventArgs
{
/// <summary>
- /// Class to generate the BigPicture style notification
+ /// Class to get infomation about Notification BigPticture style.
/// </summary>
public class BigPictureStyleArgs : StyleArgs
{
/// <summary>
/// Gets the path of the image file to display on the image of BigPicture style.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.BigPictureStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.BigPictureStyleArgs>();
- /// string imagePath = style.ImagePath;
- /// </code>
- /// </example>
public string ImagePath { get; internal set; }
/// <summary>
/// Gets the size image to display on the image of BigPicture style.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.BigPictureStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.BigPictureStyleArgs>();
- /// int imagesize = imagePath = style.ImageSize;
- /// </code>
- /// </example>
public int ImageSize { get; internal set; }
/// <summary>
/// Gets the content to display BigPicture style.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.BigPictureStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.BigPictureStyleArgs>();
- /// string content = imagePath = style.Content;
- /// </code>
- /// </example>
public string Content { get; internal set; }
internal override string Key
public partial class NotificationEventArgs
{
/// <summary>
- /// Class to display the buttons on the active notification.
+ /// Class to get infomation about Notification ButtonAction.
/// </summary>
public class ButtonActionArgs
{
/// <summary>
/// Gets the Index of the Button which is appeared at Notification.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ButtonActionArgs button = style.Button;
- /// ButtonIndex index = button.Index;
- /// </code>
- /// </example>
public ButtonIndex Index { get; internal set; }
/// <summary>
/// Gets the text that describes the button.
/// </summary>
- /// <value>
- /// Default value is null.
- /// </value>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ButtonActionArgs button = style.Button;
- /// string text = button.Text;
- /// </code>
- /// </example>
public string Text { get; internal set; }
/// <summary>
/// Gets the image's path that represent the button.
/// </summary>
- /// <value>
- /// Default value is null.
- /// </value>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ButtonActionArgs button = style.Button;
- /// string imagePath = button.ImagePath;
- /// </code>
- /// </example>
public string ImagePath { get; internal set; }
/// <summary>
/// Gets the AppControl that is invoked when the button is clicked.
/// </summary>
- /// <value>
- /// Default value is null.
- /// </value>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ButtonActionArgs button = style.Button;
- /// AppControl action = button.Action;
- /// </code>
- /// </example>
public AppControl Action { get; internal set; }
}
}
public class IndicatorStyleArgs : StyleArgs
{
/// <summary>
- /// Gets the path of the image to display on the icon of the indicator style.
+ /// Class to get infomation about Notification Indicator style.
/// </summary>
- /// <example>
- /// <code>
- /// string iconPath = NotificationEventArgs.IndicatorStyleArgs.IconPath;
- /// </code>
- /// </example>
public string IconPath { get; internal set; }
/// <summary>
/// Gets the sub text to display Indicator style.
/// </summary>
- /// <example>
- /// <code>
- /// string subText = NotificationEventArgs.IndicatorStyleArgs.SubText;
- /// </code>
- /// </example>
public string SubText { get; internal set; }
internal override string Key
public partial class NotificationEventArgs
{
/// <summary>
- /// Class to generate the Lock style notification.
+ /// Class to get infomation about Notification Lock style.
/// </summary>
public class LockStyleArgs : StyleArgs
{
/// <summary>
/// Gets the path of the image file to display on the icon of Lock style.
/// </summary>
- /// <example>
- /// <code>
- /// string iconPath = NotificationEventArgs.LockStyleArgs.IconPath;
- /// </code>
- /// </example>
public string IconPath { get; internal set; }
/// <summary>
/// Gets the path of the thumbnail image file to display on the icon of Lock style.
/// </summary>
- /// <example>
- /// <code>
- /// string thumbnail = NotificationEventArgs.LockStyleArgs.Thumbnail;
- /// </code>
- /// </example>
public string Thumbnail { get; internal set; }
internal override string Key
public partial class NotificationEventArgs
{
/// <summary>
- /// Class to display the progress notification.
+ /// Class to get infomation about Progress Notification.
/// </summary>
public class ProgressArgs
{
/// <summary>
/// Gets category of ProgressType.
/// </summary>
- /// <example>
- /// <code>
- /// ProgressCategory category = NotificationEventArgs.Progress.Category;
- /// </code>
- /// </example>
public ProgressCategory Category { get; internal set; }
/// <summary>
/// Gets current value of ProgressType.
/// </summary>
- /// <value>
- /// ProgressCurrent should not be less than 0 or greater than ProgressMax
- /// </value>
- /// <example>
- /// <code>
- /// double current = NotificationEventArgs.Progress.Current;
- /// </code>
- /// </example>
public double Current { get; internal set; }
/// <summary>
/// Gets max value of ProgressType.
/// </summary>
- /// <example>
- /// <code>
- /// double max = NotificationEventArgs.Progress.Max;
- /// </code>
- /// </example>
public double Max { get; internal set; }
}
}
public partial class NotificationEventArgs
{
/// <summary>
- /// Class to display the direct reply on the active notification.
+ /// Class to get infomation about Notification ReplyAction.
/// </summary>
public class ReplyActionArgs
{
/// Gets Index of Button which is appeared at Notification.
/// If there is no ParentIndex, the ReplyAction should be displayed directly on the active notification.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
- /// ButtonIndex buttonIndex = action.ParentIndex;
- /// </code>
- /// </example>
public ButtonIndex ParentIndex { get; internal set; } = ButtonIndex.None;
/// <summary>
/// Gets the PlaceHolderText of ReplyAction which is appeared at Notification.
/// It will be displayed to the text input box on the active notification.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
- /// string placeholderText = action.PlaceHolderText;
- /// </code>
- /// </example>
public string PlaceHolderText { get; internal set; }
/// <summary>
/// Gets a max length of text input.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
- /// int replyMax = action.ReplyMax;
- /// </code>
- /// </example>
public int ReplyMax { get; internal set; }
/// <summary>
/// Gets the button displayed in the replyaction.
/// </summary>
- /// <example>
- /// <code>
- /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
- /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
- /// ButtonActionArgs button = action.Button;
- /// </code>
- /// </example>
public ButtonActionArgs Button { get; internal set; }
}
}
projects / platform / core / csapi / tizenfx.git / commitdiff