From 1bbbb644ee4103bbc47c30c689c21db48b72ab7f Mon Sep 17 00:00:00 2001 From: Myungki Lee Date: Thu, 27 Apr 2017 15:32:08 +0900 Subject: [PATCH] Update the summary that describes the class Change-Id: I7b56f83ea18b7f516316b1b063041d1e80eb2bc1 Signed-off-by: Myungki Lee --- Tizen.Applications.sln | 1 - ...n.Applications.NotificationEventListener.csproj | 2 +- .../NotificationAccessoryArgsBinder.cs | 2 +- .../NotificationButtonActionArgsBinder.cs | 4 ++-- .../NotificationDeleteEventArgs.cs | 3 +++ .../NotificationDeleteEventArgsBinder.cs | 2 +- .../NotificationEventArgs.cs | 6 ++++++ .../NotificationEventArgsAccessory.cs | 6 ++++++ .../NotificationEventArgsActiveStyle.cs | 7 ++++-- .../NotificationEventArgsBigPictureStyle.cs | 8 ++++++- .../NotificationEventArgsBinder.cs | 2 +- .../NotificationEventArgsButtonAction.cs | 24 +++++++++++++++------ .../NotificationEventArgsEnumerations.cs | 2 +- .../NotificationEventArgsIndicatorStyle.cs | 5 ++++- .../NotificationEventArgsLockStyle.cs | 6 ++++++ .../NotificationEventArgsProgress.cs | 3 +++ .../NotificationEventArgsReplyAction.cs | 25 +++++++++++++++++++--- .../NotificationEventArgsStyle.cs | 3 +++ .../NotificationListenerManager.cs | 6 ++++++ .../NotificationProgressArgsBinder.cs | 2 +- .../NotificationReplyActionArgsBinder.cs | 2 +- .../NotificationStyleArgsBinder.cs | 2 +- 22 files changed, 98 insertions(+), 25 deletions(-) diff --git a/Tizen.Applications.sln b/Tizen.Applications.sln index 1749742..ba107d9 100755 --- a/Tizen.Applications.sln +++ b/Tizen.Applications.sln @@ -1,4 +1,3 @@ - Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 14 VisualStudioVersion = 14.0.25420.1 diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener.csproj b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener.csproj index 844bf96..7366d3e 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener.csproj +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener.csproj @@ -1,4 +1,4 @@ - + 14.0 diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationAccessoryArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationAccessoryArgsBinder.cs index a915a71..a46c90f 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationAccessoryArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationAccessoryArgsBinder.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationButtonActionArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationButtonActionArgsBinder.cs index ba8ee8a..e252015 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationButtonActionArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationButtonActionArgsBinder.cs @@ -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) diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs index c890874..c358c1b 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs @@ -16,6 +16,9 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the property to get information about the deleted notification. + /// public class NotificationDeleteEventArgs { /// diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgsBinder.cs index e353114..35108cd 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgsBinder.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs index 43d3eac..541a58f 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs @@ -20,6 +20,9 @@ namespace Tizen.Applications.NotificationEventListener using System.Collections.Generic; using System.ComponentModel; + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { private const string LogTag = "Tizen.Applications.NotificationEventListener"; @@ -28,6 +31,9 @@ namespace Tizen.Applications.NotificationEventListener internal IDictionary Extender; internal Interop.NotificationEventListener.SafeNotificationHandle Handle; + /// + /// Initializes a new instance of the class. + /// public NotificationEventArgs() { Style = new Dictionary(); diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs index 50e4fe7..878f9ff 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs @@ -18,8 +18,14 @@ namespace Tizen.Applications.NotificationEventListener { using Tizen.Common; + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { + /// + /// Class for Notification AccessorySet which is included vibration, led, sound option + /// public class AccessoryArgs { /// diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs index 66cd949..10af324 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs @@ -19,14 +19,17 @@ namespace Tizen.Applications.NotificationEventListener using System.Collections.Generic; /// - /// Class for generating Active style notification + /// This class provides the methods and properties to get information about the posted or updated notification. /// public partial class NotificationEventArgs { + /// + /// Class to generate the Active style notification + /// public class ActiveStyleArgs : StyleArgs { /// - /// Constructor + /// Initializes a new instance of the class. /// public ActiveStyleArgs() { diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBigPictureStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBigPictureStyle.cs index 042f9ca..de54087 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBigPictureStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBigPictureStyle.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); @@ -16,8 +16,14 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { + /// + /// Class to generate the BigPicture style notification + /// public class BigPictureStyleArgs : StyleArgs { /// diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs index 923d954..a466906 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBinder.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs index 211f962..e5fb873 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs @@ -16,11 +16,13 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { /// - /// 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. /// public class ButtonActionArgs { @@ -29,10 +31,12 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// int index = NotificationEventArgs.ButtonActionArgs.Index; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ButtonActionArgs button = style.Button; + /// ButtonIndex index = button.Index; /// /// - public int Index { get; internal set; } + public ButtonIndex Index { get; internal set; } /// /// Gets the text that describes the button. @@ -42,7 +46,9 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// string text = NotificationEventArgs.ButtonActionArgs.Text; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ButtonActionArgs button = style.Button; + /// string text = button.Text; /// /// public string Text { get; internal set; } @@ -55,7 +61,9 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// string imagePath = NotificationEventArgs.ButtonActionArgs.ImagePath; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ButtonActionArgs button = style.Button; + /// string imagePath = button.ImagePath; /// /// public string ImagePath { get; internal set; } @@ -68,7 +76,9 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// AppControl action = NotificationEventArgs.ButtonActionArgs.Action; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ButtonActionArgs button = style.Button; + /// AppControl action = button.Action; /// /// public AppControl Action { get; internal set; } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs index 430d9d6..531c2f7 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs @@ -356,7 +356,7 @@ namespace Tizen.Applications.NotificationEventListener } /// - /// Enumeration for notification lauch option type. + /// Enumeration for notification launch option type. /// internal enum LaunchOption { diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs index ca05efd..4712f4f 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs @@ -16,10 +16,13 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { /// - /// Class for generating Indicator style notification. + /// Class to generate the Indicator style notification. /// public class IndicatorStyleArgs : StyleArgs { diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs index f45929b..02d5af5 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs @@ -16,8 +16,14 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { + /// + /// Class to generate the Lock style notification. + /// public class LockStyleArgs : StyleArgs { /// diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs index 7ddbce2..9fde80f 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs @@ -16,6 +16,9 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { /// diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs index 2a81fb6..73ea623 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs @@ -16,14 +16,27 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { + /// + /// Class to display the direct reply on the active notification. + /// 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. /// + /// + /// + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ReplyActionArgs action = style.Reply; + /// ButtonIndex buttonIndex = action.ParentIndex; + /// + /// public ButtonIndex ParentIndex { get; internal set; } = ButtonIndex.None; /// @@ -32,7 +45,9 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// string placeholderText = NotificationEventArgs.ReplyActionArgs.PlaceHolderText; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ReplyActionArgs action = style.Reply; + /// string placeholderText = action.PlaceHolderText; /// /// public string PlaceHolderText { get; internal set; } @@ -42,7 +57,9 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// int replyMax = NotificationEventArgs.ReplyActionArgs.ReplyMax; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ReplyActionArgs action = style.Reply; + /// int replyMax = action.ReplyMax; /// /// public int ReplyMax { get; internal set; } @@ -52,7 +69,9 @@ namespace Tizen.Applications.NotificationEventListener /// /// /// - /// ButtonActionArgs button = NotificationEventArgs.ReplyActionArgs.Button; + /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle(); + /// NotificationEventArgs.ReplyActionArgs action = style.Reply; + /// ButtonActionArgs button = action.Button; /// /// public ButtonActionArgs Button { get; internal set; } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs index dbbdb84..5ba07c7 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs @@ -16,6 +16,9 @@ namespace Tizen.Applications.NotificationEventListener { + /// + /// This class provides the methods and properties to get information about the posted or updated notification. + /// public partial class NotificationEventArgs { public abstract class StyleArgs diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs index d13f9b1..a006293 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs @@ -21,6 +21,12 @@ namespace Tizen.Applications.NotificationEventListener using System.ComponentModel; using System.Runtime.InteropServices; + /// + /// This class provides a way to register callback function for some notification events. + /// + /// + /// The event listener can use this class to get a list of notification or to clear notifications. + /// public partial class NotificationListenerManager { private const string LogTag = "Tizen.Applications.NotificationEventListener"; diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationProgressArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationProgressArgsBinder.cs index 85c5019..2eca359 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationProgressArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationProgressArgsBinder.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationReplyActionArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationReplyActionArgsBinder.cs index 9379d71..a851009 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationReplyActionArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationReplyActionArgsBinder.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationStyleArgsBinder.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationStyleArgsBinder.cs index 2fb551f..ccb4616 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationStyleArgsBinder.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationStyleArgsBinder.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); -- 2.7.4