Update the summary that describes the class
authorMyungki Lee <mk5004.lee@samsung.com>
Thu, 27 Apr 2017 06:32:08 +0000 (15:32 +0900)
committerMyungki Lee <mk5004.lee@samsung.com>
Thu, 27 Apr 2017 06:32:08 +0000 (15:32 +0900)
Change-Id: I7b56f83ea18b7f516316b1b063041d1e80eb2bc1
Signed-off-by: Myungki Lee <mk5004.lee@samsung.com>
22 files changed:
Tizen.Applications.sln
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener.csproj
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationAccessoryArgsBinder.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationButtonActionArgsBinder.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgsBinder.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBigPictureStyle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationProgressArgsBinder.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationReplyActionArgsBinder.cs
src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationStyleArgsBinder.cs

index 1749742..ba107d9 100755 (executable)
@@ -1,4 +1,3 @@
-
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 14
 VisualStudioVersion = 14.0.25420.1
index 844bf96..7366d3e 100755 (executable)
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <MinimumVisualStudioVersion>14.0</MinimumVisualStudioVersion>
index ba8ee8a..e252015 100755 (executable)
@@ -1,4 +1,4 @@
-/*
+/*
  * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
@@ -25,7 +25,7 @@ namespace Tizen.Applications.NotificationEventListener
             SafeAppControlHandle appcontrol = null;
             NotificationEventArgs.ButtonActionArgs button = new NotificationEventArgs.ButtonActionArgs();
 
-            button.Index = index;
+            button.Index = (ButtonIndex)index;
 
             Interop.NotificationEventListener.GetImage(eventargs.Handle, NotificationImage.Button_1 + index, out text);
             if (string.IsNullOrEmpty(text) == false)
index c890874..c358c1b 100755 (executable)
@@ -16,6 +16,9 @@
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the property to get information about the deleted notification.
+    /// </summary>
     public class NotificationDeleteEventArgs
     {
         /// <summary>
index 43d3eac..541a58f 100755 (executable)
@@ -20,6 +20,9 @@ namespace Tizen.Applications.NotificationEventListener
     using System.Collections.Generic;
     using System.ComponentModel;
 
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
         private const string LogTag = "Tizen.Applications.NotificationEventListener";
@@ -28,6 +31,9 @@ namespace Tizen.Applications.NotificationEventListener
         internal IDictionary<string, Bundle> Extender;
         internal Interop.NotificationEventListener.SafeNotificationHandle Handle;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NotificationEventArgs"/> class.
+        /// </summary>
         public NotificationEventArgs()
         {
             Style = new Dictionary<string, StyleArgs>();
index 50e4fe7..878f9ff 100755 (executable)
@@ -18,8 +18,14 @@ namespace Tizen.Applications.NotificationEventListener
 {
     using Tizen.Common;
 
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
+        /// <summary>
+        /// Class for Notification AccessorySet which is included vibration, led, sound option
+        /// </summary>
         public class AccessoryArgs
         {
             /// <summary>
index 66cd949..10af324 100755 (executable)
@@ -19,14 +19,17 @@ namespace Tizen.Applications.NotificationEventListener
     using System.Collections.Generic;
 
     /// <summary>
-    ///  Class for generating Active style notification
+    /// This class provides the methods and properties to get information about the posted or updated notification.
     /// </summary>
     public partial class NotificationEventArgs
     {
+        /// <summary>
+        ///  Class to generate the Active style notification
+        /// </summary>
         public class ActiveStyleArgs : StyleArgs
         {
             /// <summary>
-            /// Constructor
+            /// Initializes a new instance of the <see cref="ActiveStyleArgs"/> class.
             /// </summary>
             public ActiveStyleArgs()
             {
index 042f9ca..de54087 100755 (executable)
@@ -1,4 +1,4 @@
-/*
+/*
  * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
+        /// <summary>
+        ///  Class to generate the BigPicture style notification
+        /// </summary>
         public class BigPictureStyleArgs : StyleArgs
         {
             /// <summary>
index 211f962..e5fb873 100755 (executable)
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
         /// <summary>
-        ///  Structure to encapsulate Notification ButtonAction.
-        ///  You can get an Text, ImagePath, Action to be invoked when the button is click by the user.
+        ///  Class to display the buttons on the active notification.
         /// </summary>
         public class ButtonActionArgs
         {
@@ -29,10 +31,12 @@ namespace Tizen.Applications.NotificationEventListener
             /// </summary>
             /// <example>
             /// <code>
-            /// int index = NotificationEventArgs.ButtonActionArgs.Index;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
+            /// ButtonIndex index = button.Index;
             /// </code>
             /// </example>
-            public int Index { get; internal set; }
+            public ButtonIndex Index { get; internal set; }
 
             /// <summary>
             /// Gets the text that describes the button.
@@ -42,7 +46,9 @@ namespace Tizen.Applications.NotificationEventListener
             /// </value>
             /// <example>
             /// <code>
-            /// string text = NotificationEventArgs.ButtonActionArgs.Text;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
+            /// string text = button.Text;
             /// </code>
             /// </example>
             public string Text { get; internal set; }
@@ -55,7 +61,9 @@ namespace Tizen.Applications.NotificationEventListener
             /// </value>
             /// <example>
             /// <code>
-            /// string imagePath = NotificationEventArgs.ButtonActionArgs.ImagePath;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
+            /// string imagePath = button.ImagePath;
             /// </code>
             /// </example>
             public string ImagePath { get; internal set; }
@@ -68,7 +76,9 @@ namespace Tizen.Applications.NotificationEventListener
             /// </value>
             /// <example>
             /// <code>
-            /// AppControl action = NotificationEventArgs.ButtonActionArgs.Action;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
+            /// AppControl action = button.Action;
             /// </code>
             /// </example>
             public AppControl Action { get; internal set; }
index 430d9d6..531c2f7 100755 (executable)
@@ -356,7 +356,7 @@ namespace Tizen.Applications.NotificationEventListener
     }
 
     /// <summary>
-    /// Enumeration for notification lauch option type.
+    /// Enumeration for notification launch option type.
     /// </summary>
     internal enum LaunchOption
     {
index ca05efd..4712f4f 100755 (executable)
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
         /// <summary>
-        ///  Class for generating Indicator style notification.
+        ///  Class to generate the Indicator style notification.
         /// </summary>
         public class IndicatorStyleArgs : StyleArgs
         {
index f45929b..02d5af5 100755 (executable)
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
+        /// <summary>
+        ///  Class to generate the Lock style notification.
+        /// </summary>
         public class LockStyleArgs : StyleArgs
         {
             /// <summary>
index 7ddbce2..9fde80f 100755 (executable)
@@ -16,6 +16,9 @@
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
         /// <summary>
index 2a81fb6..73ea623 100755 (executable)
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
+        /// <summary>
+        ///  Class to display the direct reply on the active notification.
+        /// </summary>
         public class ReplyActionArgs
         {
             /// <summary>
             /// 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>
@@ -32,7 +45,9 @@ namespace Tizen.Applications.NotificationEventListener
             /// </summary>
             /// <example>
             /// <code>
-            /// string placeholderText = NotificationEventArgs.ReplyActionArgs.PlaceHolderText;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
+            /// string placeholderText = action.PlaceHolderText;
             /// </code>
             /// </example>
             public string PlaceHolderText { get; internal set; }
@@ -42,7 +57,9 @@ namespace Tizen.Applications.NotificationEventListener
             /// </summary>
             /// <example>
             /// <code>
-            /// int replyMax = NotificationEventArgs.ReplyActionArgs.ReplyMax;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
+            /// int replyMax = action.ReplyMax;
             /// </code>
             /// </example>
             public int ReplyMax { get; internal set; }
@@ -52,7 +69,9 @@ namespace Tizen.Applications.NotificationEventListener
             /// </summary>
             /// <example>
             /// <code>
-            /// ButtonActionArgs button = NotificationEventArgs.ReplyActionArgs.Button;
+            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
+            /// NotificationEventArgs.ReplyActionArgs action = style.Reply;
+            /// ButtonActionArgs button = action.Button;
             /// </code>
             /// </example>
             public ButtonActionArgs Button { get; internal set; }
index dbbdb84..5ba07c7 100755 (executable)
@@ -16,6 +16,9 @@
 
 namespace Tizen.Applications.NotificationEventListener
 {
+    /// <summary>
+    /// This class provides the methods and properties to get information about the posted or updated notification.
+    /// </summary>
     public partial class NotificationEventArgs
     {
         public abstract class StyleArgs
index d13f9b1..a006293 100755 (executable)
@@ -21,6 +21,12 @@ namespace Tizen.Applications.NotificationEventListener
     using System.ComponentModel;
     using System.Runtime.InteropServices;
 
+    /// <summary>
+    /// This class provides a way to register callback function for some notification events.
+    /// </summary>
+    /// <remarks>
+    /// The event listener can use this class to get a list of notification or to clear notifications.
+    /// </remarks>
     public partial class NotificationListenerManager
     {
         private const string LogTag = "Tizen.Applications.NotificationEventListener";