diff options
author | Editor Lionbridge <TizenEditor.SEL@lionbridge.com> | 2017-07-28 14:38:15 +0530 |
---|---|---|
committer | Semun Lee <semun.lee@samsung.com> | 2017-08-17 14:23:02 +0900 |
commit | 282065b56965a51b79160b546f482b383753fb7b (patch) | |
tree | 8ba614502fb392199d064aa9fbc0609c993a1ffb | |
parent | 25383beb0548289fc26f364faf5e50241b7094bc (diff) | |
download | application-282065b56965a51b79160b546f482b383753fb7b.tar.gz application-282065b56965a51b79160b546f482b383753fb7b.tar.bz2 application-282065b56965a51b79160b546f482b383753fb7b.zip |
Review application API cs file
PS2: Rebase
PS3: Revert to PS1
PS4: Further edits
Change-Id: If7ebd70128f6beb8673e9e5196170f219f953034
86 files changed, 997 insertions, 997 deletions
diff --git a/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs b/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs index af69b75..0169151 100755 --- a/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs +++ b/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// The Alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future. + /// The alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future. /// </summary> /// <example> /// <code> @@ -36,7 +36,7 @@ namespace Tizen.Applications private const string _logTag = "Tizen.Applications.Alarm"; /// <summary> - /// Constructor created with new AlarmId. + /// Constructor created with the new AlarmId. /// </summary> /// <param name="id"></param> internal Alarm(int id) @@ -57,7 +57,7 @@ namespace Tizen.Applications /// </summary> /// <privilege>http://tizen.org/privilege/alarm.get</privilege> /// <remarks> - /// week_flag may be a combination of days, like Tuesday | Friday + /// week_flag may be a combination of days, like Tuesday | Friday. /// </remarks> public AlarmWeekFlag WeekFlag { @@ -163,10 +163,10 @@ namespace Tizen.Applications } /// <summary> - /// Cancels the the specific alarm. + /// Cancels the specific alarm. /// </summary> - /// <exception cref="ArgumentException">Thrown in case of Invalid parmaeter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied due to insufficient previlleges.</exception> + /// <exception cref="ArgumentException">Thrown in case of an invalid parmaeter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied due to insufficient privileges.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> public void Cancel() diff --git a/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs b/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs index 60d2954..7faff6f 100755 --- a/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs +++ b/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs @@ -22,63 +22,63 @@ namespace Tizen.Applications using Tizen.Applications.Notifications; /// <summary> - /// Enumeration for Alarm Week Flag, the days of the week. + /// Enumeration for alarm week flag, the days of the week. /// </summary> [Flags] public enum AlarmWeekFlag { /// <summary> - /// Identifier for Sunday. + /// An identifier for Sunday. /// </summary> Sunday = 0x01, /// <summary> - /// Identifier for Monday. + /// An identifier for Monday. /// </summary> Monday = 0x02, /// <summary> - /// Identifier for Tuesday. + /// An identifier for Tuesday. /// </summary> Tuesday = 0x04, /// <summary> - /// Identifier for Wednesday. + /// An identifier for Wednesday. /// </summary> Wednesday = 0x08, /// <summary> - /// Identifier for Thursday. + /// An identifier for Thursday. /// </summary> Thursday = 0x10, /// <summary> - /// Identifier for Friday. + /// An identifier for Friday. /// </summary> Friday = 0x20, /// <summary> - /// Identifier for Saturday. + /// An identifier for Saturday. /// </summary> Saturday = 0x40, /// <summary> - /// All Days of the Week. + /// All days of the week. /// </summary> AllDays = Sunday |Monday|Tuesday|Wednesday|Thursday|Friday|Saturday, /// <summary> - /// Only Weekdays + /// Only weekdays. /// </summary> WeekDays = Monday | Tuesday | Wednesday | Thursday | Friday } /// <summary> - /// Mobile devices typically give constant access to information from various sources.Some of this information is best delivered through alarms - - /// the most obvious case is a calendar scheduling application which lets you know when a meeting is about to start.Alarms are certainly better than actively waiting in a loop. + /// Mobile devices typically give constant access to information from various sources. Some of this information is best delivered through alarms. + /// The most obvious case is a calendar scheduling application, which lets you know when a meeting is about to start. Alarms are certainly better than actively waiting in a loop. /// They are also better than putting an interface to sleep because they do not block your main UI thread. /// Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks. - /// If an application is installed after setting the alarm, your alarm is cancelled automatically. + /// If an application is installed after setting the alarm, your alarm is canceled automatically. /// </summary> /// <example> /// <code> @@ -122,11 +122,11 @@ namespace Tizen.Applications /// </summary> /// <param name="delay">The amount of time before the first execution (in seconds).</param> /// <param name="period"> The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. - /// The actual interval is calculated by the OS. The minimum value is 600sec</param> - /// <param name="appControl"> The destination AppControl to perform a specific task when the alarm is triggered </param> - /// <returns>Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// The actual interval is calculated by the OS. The minimum value is 600sec.</param> + /// <param name="appControl"> The destination AppControl is used to perform a specific task when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> public static Alarm CreateAlarm(int delay, int period, AppControl appControl) @@ -148,11 +148,11 @@ namespace Tizen.Applications /// Sets an alarm to be triggered after a specific time. /// The alarm will go off delay seconds later. /// </summary> - /// <param name="delay"> The amount of time before the execution (in seconds) </param> - /// <param name="appControl"> The destination AppControl to perform a specific task when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="delay"> The amount of time before the execution (in seconds). </param> + /// <param name="appControl"> The destination AppControl to perform a specific task when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> public static Alarm CreateAlarm(int delay, AppControl appControl) @@ -173,12 +173,12 @@ namespace Tizen.Applications /// Sets an alarm to be triggered at a specific time. /// The date describes the time of the first occurrence. /// </summary> - /// <param name="value"> The first active alarm time </param> - /// <param name="appControl"> The destination AppControl to perform specific work when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <remarks>This operation is permitted wit UI application appcontrol only.</remarks> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="value"> The first active alarm time. </param> + /// <param name="appControl"> The destination AppControl to perform specific work when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <remarks>This operation is permitted with the UI application appcontrol only.</remarks> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> public static Alarm CreateAlarm(DateTime value, AppControl appControl) @@ -199,16 +199,16 @@ namespace Tizen.Applications /// <summary> /// Sets an alarm to be triggered periodically, starting at a specific time. /// The date describes the time of the first occurrence. - /// weekFlag is the repeat value of the days of the week. - /// If weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. + /// The weekFlag is the repeat value of the days of the week. + /// If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. /// </summary> - /// <remarks>This operation is permitted wit UI application appcontrol only.</remarks> - /// <param name="value"> The first active alarm time </param> - /// <param name="weekFlag"> The day of the week, AlarmWeekFlag may be a combination of days, like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday</param> - /// <param name="appControl"> The destination AppControl to perform specific work when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <remarks>This operation is permitted with UI application appcontrol only.</remarks> + /// <param name="value"> The first active alarm time. </param> + /// <param name="weekFlag"> The day of the week, AlarmWeekFlag may be a combination of days, like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday.</param> + /// <param name="appControl"> The destination AppControl to perform specific work when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> public static Alarm CreateAlarm(DateTime value, AlarmWeekFlag weekFlag, AppControl appControl) @@ -230,11 +230,11 @@ namespace Tizen.Applications /// Sets a notification alarm to be triggered at a specific time. /// The date describes the time of the first occurrence. /// </summary> - /// <param name="dateTime"> The first active alarm time </param> - /// <param name="notification"> The notification to be posted when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="dateTime"> The first active alarm time. </param> + /// <param name="notification"> The notification to be posted when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> /// <privilege>http://tizen.org/privilege/notification</privilege> @@ -261,10 +261,10 @@ namespace Tizen.Applications /// </summary> /// <param name="delay">The amount of time before the first execution (in seconds). </param> /// <param name="period"> The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. </param> - /// <param name="notification"> The notification to be posted when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="notification"> The notification to be posted when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> /// <privilege>http://tizen.org/privilege/notification</privilege> @@ -287,16 +287,16 @@ namespace Tizen.Applications /// <summary> /// Sets a notification alarm to be triggered periodically, starting at a specific time. /// The date describes the time of the first occurrence. - /// weekFlag is the repeat value of the days of the week. - /// If weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. + /// The weekFlag is the repeat value of the days of the week. + /// If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. /// </summary> - /// <param name="dateTime"> The first active alarm time </param> + /// <param name="dateTime"> The first active alarm time. </param> /// <param name="weekFlag"> The day of the week, AlarmWeekFlag may be a combination of days, - /// like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday</param> - /// <param name="notification"> The notification to be posted when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday.</param> + /// <param name="notification"> The notification to be posted when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> /// <privilege>http://tizen.org/privilege/notification</privilege> @@ -322,10 +322,10 @@ namespace Tizen.Applications /// The alarm will go off delay seconds later. /// </summary> /// <param name="delay">The amount of time before the first execution (in seconds).</param> - /// <param name="notification"> The notification to be posted when the alarm is triggered </param> - /// <returns> Alarm Instance created with the set param values.</returns> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="notification"> The notification to be posted when the alarm is triggered. </param> + /// <returns> An alarm instance is created with the set param values.</returns> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> /// <privilege>http://tizen.org/privilege/notification</privilege> @@ -348,7 +348,7 @@ namespace Tizen.Applications /// <summary> /// Cancels all scheduled alarms that are registered by the application that calls this API. /// </summary> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> public static void CancelAll() @@ -363,8 +363,8 @@ namespace Tizen.Applications /// <summary> /// Retrieves all registered alarms. /// </summary> - /// <returns>List of all Alarm instances.</returns> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <returns>List of all alarm instances.</returns> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/alarm.get</privilege> public static IEnumerable<Alarm> GetAllScheduledAlarms() @@ -388,7 +388,7 @@ namespace Tizen.Applications /// <summary> /// Gets the current system time. /// </summary> - /// <returns>The current system time</returns> + /// <returns>The current system time.</returns> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> public static DateTime GetCurrentTime() { diff --git a/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs b/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs index aabbbeb..24915d9 100755 --- a/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs +++ b/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs @@ -22,12 +22,12 @@ using Tizen.Internals.Errors; namespace Tizen.Applications.CoreBackend { /// <summary> - /// Abstract class to provide default event handlers for apps. + /// An abstract class to provide default event handlers for apps. /// </summary> public abstract class DefaultCoreBackend : ICoreBackend { /// <summary> - /// Low level event types + /// Low level event types. /// </summary> public enum AppEventType { diff --git a/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs b/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs index e24cddf..2eadeb6 100755 --- a/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs +++ b/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs @@ -16,62 +16,62 @@ namespace Tizen.Applications.CoreBackend { /// <summary> - /// Class that represents the type of event for backends. This class can be converted from string type. + /// This class represents the type of event for backends. This class can be converted from the string type. /// </summary> public class EventType { /// <summary> - /// Pre-defined event type. "PreCreated" + /// Pre-defined event type "PreCreated". /// </summary> public static readonly EventType PreCreated = "PreCreated"; /// <summary> - /// Pre-defined event type. "Created" + /// Pre-defined event type "Created". /// </summary> public static readonly EventType Created = "Created"; /// <summary> - /// Pre-defined event type. "Terminated" + /// Pre-defined event type "Terminated". /// </summary> public static readonly EventType Terminated = "Terminated"; /// <summary> - /// Pre-defined event type. "AppControlReceived" + /// Pre-defined event type "AppControlReceived". /// </summary> public static readonly EventType AppControlReceived = "AppControlReceived"; /// <summary> - /// Pre-defined event type. "Resumed" + /// Pre-defined event type "Resumed". /// </summary> public static readonly EventType Resumed = "Resumed"; /// <summary> - /// Pre-defined event type. "Paused" + /// Pre-defined event type "Paused". /// </summary> public static readonly EventType Paused = "Paused"; /// <summary> - /// Pre-defined event type. "LowMemory" + /// Pre-defined event type "LowMemory". /// </summary> public static readonly EventType LowMemory = "LowMemory"; /// <summary> - /// Pre-defined event type. "LowBattery" + /// Pre-defined event type "LowBattery". /// </summary> public static readonly EventType LowBattery = "LowBattery"; /// <summary> - /// Pre-defined event type. "LocaleChanged" + /// Pre-defined event type "LocaleChanged". /// </summary> public static readonly EventType LocaleChanged = "LocaleChanged"; /// <summary> - /// Pre-defined event type. "RegionFormatChanged" + /// Pre-defined event type "RegionFormatChanged". /// </summary> public static readonly EventType RegionFormatChanged = "RegionFormatChanged"; /// <summary> - /// Pre-defined event type. "DeviceOrientationChanged" + /// Pre-defined event type "DeviceOrientationChanged". /// </summary> public static readonly EventType DeviceOrientationChanged = "DeviceOrientationChanged"; diff --git a/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs b/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs index 0ba8be5..3b94150 100755 --- a/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs +++ b/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications.CoreBackend { /// <summary> - /// Interface that represents the backend lifecycles. + /// An interface that represents the backend lifecycles. /// </summary> public interface ICoreBackend : IDisposable { @@ -39,13 +39,13 @@ namespace Tizen.Applications.CoreBackend void AddEventHandler<TEventArgs>(EventType evType, Action<TEventArgs> handler) where TEventArgs : EventArgs; /// <summary> - /// Runs the mainloop of backend. + /// Runs the mainloop of the backend. /// </summary> /// <param name="args"></param> void Run(string[] args); /// <summary> - /// Exits the mainloop of backend. + /// Exits the mainloop of the backend. /// </summary> void Exit(); } diff --git a/Tizen.Applications.Common/Tizen.Applications/AppControl.cs b/Tizen.Applications.Common/Tizen.Applications/AppControl.cs index 1128f02..fd4c79c 100755 --- a/Tizen.Applications.Common/Tizen.Applications/AppControl.cs +++ b/Tizen.Applications.Common/Tizen.Applications/AppControl.cs @@ -59,7 +59,7 @@ namespace Tizen.Applications /// <summary> /// Initializes the instance of the AppControl class. /// </summary> - /// <exception cref="InvalidOperationException">Thrown when failed to create AppControl handle.</exception> + /// <exception cref="InvalidOperationException">Thrown when failed to create the AppControl handle.</exception> public AppControl() { Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle); @@ -70,10 +70,10 @@ namespace Tizen.Applications } /// <summary> - /// Initializes the instance of the AppControl class with parameter. + /// Initializes the instance of the AppControl class with a parameter. /// </summary> - /// <param name="enableAppStartedResultEvent">The flag value to receive an additional launch result event on launch request.</param> - /// <exception cref="InvalidOperationException">Thrown when failed to create AppControl handle.</exception> + /// <param name="enableAppStartedResultEvent">The flag value to receive an additional launch result event on the launch request.</param> + /// <exception cref="InvalidOperationException">Thrown when failed to create the AppControl handle.</exception> public AppControl(bool enableAppStartedResultEvent) { Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle); @@ -222,7 +222,7 @@ namespace Tizen.Applications /// </summary> /// <value> /// Since Tizen 2.4, if the parameter 'uri' is started with 'file://' and - /// it is a regular file in this application's data path which can be obtained + /// it is a regular file in this application's data path, which can be obtained /// by property DataPath in ApplicationInfo class, /// it will be shared to the callee application. /// Framework will grant a temporary permission to the callee application for this file and @@ -308,10 +308,10 @@ namespace Tizen.Applications } /// <summary> - /// Gets and sets the application id to explicitly launch. + /// Gets and sets the application ID to explicitly launch. /// </summary> /// <value> - /// (if the application id is null for setter, it clears the previous value.) + /// (if the application ID is null for setter, it clears the previous value.) /// </value> /// <example> /// <code> @@ -352,13 +352,13 @@ namespace Tizen.Applications /// Gets and sets the launch mode of the application. /// </summary> /// <value> - /// Although LaunchMode were set as AppControlLaunchMode.Group, - /// callee application would be launched as single mode + /// Although, LaunchMode were set as AppControlLaunchMode.Group, the + /// callee application would be launched as a single mode /// if the manifest file of callee application defined the launch mode as "single". - /// This property can just set the preference of caller application to launch an application. - /// Sub-applications which were launched as group mode always have own process. - /// Since Tizen 3.0, if launch mode not set in the caller app control, - /// this property returns AppControlLaunchMode.Single launch mode. + /// This property can just set the preference of the caller application to launch an application. + /// Sub-applications, which were launched as a group mode always have own process. + /// Since Tizen 3.0, if launch mode is not set in the caller application control, + /// this property returns the AppControlLaunchMode.Single launch mode. /// </value> /// <example> /// <code> @@ -416,9 +416,9 @@ namespace Tizen.Applications /// <summary> /// Retrieves all applications that can be launched to handle the given app_control request. /// </summary> - /// <param name="control">The AppControl</param> - /// <returns>ApplicationIds</returns> - /// <exception cref="InvalidOperationException">Thrown when failed because of invalid parameter</exception> + /// <param name="control">The AppControl.</param> + /// <returns>ApplicationIds.</returns> + /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid parameter.</exception> /// <example> /// <code> /// IEnumerable<string> applicationIds = AppControl.GetMatchedApplicationIds(control); @@ -468,12 +468,12 @@ namespace Tizen.Applications /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n /// Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. /// Also, implicit launch requests are NOT delivered to service applications since 2.4. - /// To launch a service application, an explicit launch request with application ID given by property ApplicationId MUST be sent. + /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent. /// </remarks> - /// <param name="launchRequest">The AppControl</param> - /// <exception cref="ArgumentNullException">Thrown when failed because of a null arguament</exception> - /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception> - /// <exception cref="TimeoutException">Thrown when failed because of timeout</exception> + /// <param name="launchRequest">The AppControl.</param> + /// <exception cref="ArgumentNullException">Thrown when failed because of a null argument.</exception> + /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception> + /// <exception cref="TimeoutException">Thrown when failed because of timeout.</exception> /// <privilege>http://tizen.org/privilege/appmanager.launch</privilege> /// <example> /// <code> @@ -496,13 +496,13 @@ namespace Tizen.Applications /// If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n /// Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. /// Also, implicit launch requests are NOT delivered to service applications since 2.4. - /// To launch a service application, an explicit launch request with application ID given by property ApplicationId MUST be sent. + /// To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent. /// </remarks> - /// <param name="launchRequest">The AppControl</param> - /// <param name="replyAfterLaunching">The callback function to be called when the reply is delivered</param> - /// <exception cref="ArgumentException">Thrown when failed because of arguament is invalid</exception> - /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception> - /// <exception cref="TimeoutException">Thrown when failed because of timeout</exception> + /// <param name="launchRequest">The AppControl.</param> + /// <param name="replyAfterLaunching">The callback function to be called when the reply is delivered.</param> + /// <exception cref="ArgumentException">Thrown when failed because of the argument is invalid.</exception> + /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception> + /// <exception cref="TimeoutException">Thrown when failed because of timeout.</exception> /// <privilege>http://tizen.org/privilege/appmanager.launch</privilege> /// <example> /// <code> @@ -570,14 +570,14 @@ namespace Tizen.Applications /// </summary> /// <remarks> /// You are not allowed to terminate other general applications using this API. - /// This API can be used to terminate sub-applications which were launched as group mode by caller application. - /// Once callee application is being terminated by this API, - /// other applications which were launched by callee application as group mode will be terminated as well + /// This API can be used to terminate sub-applications, which were launched as a group mode by the caller application. + /// Once the callee application is being terminated by this API, + /// other applications, which were launched by the callee application as a group mode will be terminated as well. /// </remarks> - /// <param name="terminateRequest">The AppControl</param> - /// <exception cref="ArgumentException">Thrown when failed because of arguament is invalid</exception> - /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception> - /// <exception cref="TimeoutException">Thrown when failed because of timeout</exception> + /// <param name="terminateRequest">The AppControl.</param> + /// <exception cref="ArgumentException">Thrown when failed because of the argument is invalid.</exception> + /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception> + /// <exception cref="TimeoutException">Thrown when failed because of timeout.</exception> /// <example> /// <code> /// AppControl terminateRequest = new AppControl(); @@ -610,7 +610,7 @@ namespace Tizen.Applications } /// <summary> - /// Class for Extra Data + /// Class for extra data. /// </summary> public class ExtraDataCollection { @@ -627,10 +627,10 @@ namespace Tizen.Applications /// <remarks> /// The function replaces any existing value for the given key. /// </remarks> - /// <param name="key">The name of the extra data</param> - /// <param name="value">The value associated with the given key</param> - /// <exception cref="ArgumentNullException">Thrown when key or value is a zero-length string</exception> - /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with system-defined key</exception> + /// <param name="key">The name of the extra data.</param> + /// <param name="value">The value associated with the given key.</param> + /// <exception cref="ArgumentNullException">Thrown when a key or a value is a zero-length string.</exception> + /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with the system-defined key.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -668,10 +668,10 @@ namespace Tizen.Applications /// <remarks> /// The function replaces any existing value for the given key. /// </remarks> - /// <param name="key">The name of the extra data</param> - /// <param name="value">The value associated with the given key</param> - /// <exception cref="ArgumentNullException">Thrown when key or value is a zero-length string</exception> - /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with system-defined key</exception> + /// <param name="key">The name of the extra data.</param> + /// <param name="value">The value associated with the given key.</param> + /// <exception cref="ArgumentNullException">Thrown when key or value is a zero-length string.</exception> + /// <exception cref="ArgumentException">Thrown when the application tries to use the same key with the system-defined key.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -709,11 +709,11 @@ namespace Tizen.Applications /// Gets the extra data. /// </summary> /// <typeparam name="T">Only string and IEnumerable<string></typeparam> - /// <param name="key">The name of extra data</param> - /// <returns>The value associated with the given key</returns> - /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception> - /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception> - /// <exception cref="ArgumentException">Thrown when the key is rejected</exception> + /// <param name="key">The name of extra data.</param> + /// <returns>The value associated with the given key.</returns> + /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception> + /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception> + /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -729,11 +729,11 @@ namespace Tizen.Applications /// <summary> /// Gets the extra data. /// </summary> - /// <param name="key">The name of extra data</param> - /// <returns>The value associated with the given key</returns> - /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception> - /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception> - /// <exception cref="ArgumentException">Thrown when the key is rejected</exception> + /// <param name="key">The name of extra data.</param> + /// <returns>The value associated with the given key.</returns> + /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception> + /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception> + /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -759,8 +759,8 @@ namespace Tizen.Applications /// <summary> /// Gets all keys in extra data. /// </summary> - /// <returns>The keys in the AppControl</returns> - /// <exception cref="InvalidOperationException">Thrown when invalid parameter</exception> + /// <returns>The keys in the AppControl.</returns> + /// <exception cref="InvalidOperationException">Thrown when the key is an invalid parameter.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -800,12 +800,12 @@ namespace Tizen.Applications /// <summary> /// Tries getting the extra data. /// </summary> - /// <param name="key">The name of extra data</param> - /// <param name="value">The value associated with the given key</param> - /// <returns>The result whether getting the value is done</returns> - /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception> - /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception> - /// <exception cref="ArgumentException">Thrown when the key is rejected</exception> + /// <param name="key">The name of extra data.</param> + /// <param name="value">The value associated with the given key.</param> + /// <returns>The result whether getting the value is done.</returns> + /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception> + /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception> + /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -838,12 +838,12 @@ namespace Tizen.Applications /// <summary> /// Tries getting the extra data. /// </summary> - /// <param name="key">The name of extra data</param> - /// <param name="value">The value associated with the given key</param> - /// <returns>The result whether getting the value is done</returns> - /// <exception cref="ArgumentNullException">Thrown when the key is invalid parameter</exception> - /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception> - /// <exception cref="ArgumentException">Thrown when the key is rejected</exception> + /// <param name="key">The name of extra data.</param> + /// <param name="value">The value associated with the given key.</param> + /// <returns>The result whether getting the value is done.</returns> + /// <exception cref="ArgumentNullException">Thrown when the key is an invalid parameter.</exception> + /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception> + /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -890,10 +890,10 @@ namespace Tizen.Applications /// <summary> /// Removes the extra data. /// </summary> - /// <param name="key">The name of the extra data</param> - /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string</exception> - /// <exception cref="KeyNotFoundException">Thrown when the key is not found</exception> - /// <exception cref="ArgumentException">Thrown when the key is rejected</exception> + /// <param name="key">The name of the extra data.</param> + /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string.</exception> + /// <exception cref="KeyNotFoundException">Thrown when the key is not found.</exception> + /// <exception cref="ArgumentException">Thrown when the key is rejected.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -926,8 +926,8 @@ namespace Tizen.Applications /// <summary> /// Counts keys in the extra data. /// </summary> - /// <returns>The number of counting keys</returns> - /// <exception cref="InvalidOperationException">Thrown when invalid parameter</exception> + /// <returns>The number of counting keys.</returns> + /// <exception cref="InvalidOperationException">Thrown when the key is an invalid parameter.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); @@ -940,12 +940,12 @@ namespace Tizen.Applications } /// <summary> - /// Checks whether the extra data associated with the given key is of collection data type. + /// Checks whether the extra data associated with the given key is of the collection data type. /// </summary> - /// <param name="key">The name of the extra data</param> - /// <returns>If true the extra data is of array data type, otherwise false</returns> - /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string</exception> - /// <exception cref="InvalidOperationException">Thrown when failed to check the key</exception> + /// <param name="key">The name of the extra data.</param> + /// <returns>If true, the extra data is of the array data type, otherwise false.</returns> + /// <exception cref="ArgumentNullException">Thrown when the key is a zero-length string.</exception> + /// <exception cref="InvalidOperationException">Thrown when failed to check the key.</exception> /// <example> /// <code> /// AppControl appControl = new AppControl(); diff --git a/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs b/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs index fddfd09..b3cb0a8 100755 --- a/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs +++ b/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs @@ -22,127 +22,127 @@ namespace Tizen.Applications public static class AppControlData { /// <summary> - /// Subject + /// Subject. /// </summary> public const string Subject = "http://tizen.org/appcontrol/data/subject"; /// <summary> - /// Recipients + /// Recipients. /// </summary> public const string To = "http://tizen.org/appcontrol/data/to"; /// <summary> - /// E-mail addresses that should be carbon copied + /// E-mail addresses that should be carbon copied. /// </summary> public const string Cc = "http://tizen.org/appcontrol/data/cc"; /// <summary> - /// E-mail addresses that should be blind carbon copied + /// E-mail addresses that should be blind carbon copied. /// </summary> public const string Bcc = "http://tizen.org/appcontrol/data/bcc"; /// <summary> - /// Text + /// Text. /// </summary> public const string Text = "http://tizen.org/appcontrol/data/text"; /// <summary> - /// Title + /// Title. /// </summary> public const string Title = "http://tizen.org/appcontrol/data/title"; /// <summary> - /// Selected items + /// Selected items. /// </summary> public const string Selected = "http://tizen.org/appcontrol/data/selected"; /// <summary> - /// Paths of items + /// Paths of items. /// </summary> public const string Path = "http://tizen.org/appcontrol/data/path"; /// <summary> - /// Selection mode. ("single" or "multiple") + /// Selection mode ("single" or "multiple"). /// </summary> public const string SectionMode = "http://tizen.org/appcontrol/data/selection_mode"; /// <summary> - /// All-day mode of event ("true" or "false") + /// All-day mode of the event ("true" or "false"). /// </summary> public const string AllDay = "http://tizen.org/appcontrol/data/calendar/all_day"; /// <summary> - /// Start time of event (format: YYYY-MM-DD HH:MM:SS) + /// Start time of the event (format: YYYY-MM-DD HH:MM:SS). /// </summary> public const string StartTime = "http://tizen.org/appcontrol/data/calendar/start_time"; /// <summary> - /// End time of event (format: YYYY-MM-DD HH:MM:SS) + /// End time of the event (format: YYYY-MM-DD HH:MM:SS). /// </summary> public const string Endtime = "http://tizen.org/appcontrol/data/calendar/end_time"; /// <summary> - /// E-mail addressed + /// E-mail addressed. /// </summary> public const string Email = "http://tizen.org/appcontrol/data/email"; /// <summary> - /// Phone numbers + /// Phone numbers. /// </summary> public const string Phone = "http://tizen.org/appcontrol/data/phone"; /// <summary> - /// URLs + /// URLs. /// </summary> public const string Url = "http://tizen.org/appcontrol/data/url"; /// <summary> - /// IDs + /// IDs. /// </summary> public const string Ids = "http://tizen.org/appcontrol/data/id"; /// <summary> - /// Type + /// Type. /// </summary> public const string Type = "http://tizen.org/appcontrol/data/type"; /// <summary> - /// Total count + /// Total count. /// </summary> public const string TotalCount = "http://tizen.org/appcontrol/data/total_count"; /// <summary> - /// Total size (unit : bytes) + /// Total size (unit : bytes). /// </summary> public const string TotalSize = "http://tizen.org/appcontrol/data/total_size"; /// <summary> - /// Name + /// Name. /// </summary> public const string Name = "http://tizen.org/appcontrol/data/name"; /// <summary> - /// Location + /// Location. /// </summary> public const string Location = "http://tizen.org/appcontrol/data/location"; /// <summary> - /// Select the type of input method + /// Select the type of input method. /// </summary> public const string InputType = "http://tizen.org/appcontrol/data/input_type"; /// <summary> - /// Send the pre inputted text such as "http://" in web + /// Send the pre inputted text, such as "http://" in web. /// </summary> public const string InputDefaultText = "http://tizen.org/appcontrol/data/input_default_text"; /// <summary> - /// Send guide text to show to user such as "Input user name" + /// Send guide text to show to the user, such as "Input user name". /// </summary> public const string InputGuideText = "http://tizen.org/appcontrol/data/input_guide_text"; /// <summary> - /// Send text to receive answer result from smart reply + /// Send text to receive answer result from smart reply. /// </summary> public const string InputPredictionHint = "http://tizen.org/appcontrol/data/input_prediction_hint"; } diff --git a/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs b/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs index 728612c..1a0c5d1 100755 --- a/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs +++ b/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs @@ -17,17 +17,17 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for App Control Launch Mode. + /// Enumeration for the application control launch mode. /// </summary> public enum AppControlLaunchMode { /// <summary> - /// Prefer to launch an application as single mode + /// Prefer to launch an application as a single mode. /// </summary> Single = 0, /// <summary> - /// Prefer to launch an application as group mode + /// Prefer to launch an application as a group mode. /// </summary> Group, } diff --git a/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs b/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs index c045651..a3e4623 100755 --- a/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs +++ b/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs @@ -82,7 +82,7 @@ namespace Tizen.Applications public const string ShareText = "http://tizen.org/appcontrol/operation/share_text"; /// <summary> - /// Dials a number. This shows a UI with the number to be dialed, allowing the user to explicitly initiate the call. + /// Dials a number. This shows an UI with the number to be dialed, allowing the user to explicitly initiate the call. /// </summary> public const string Dial = "http://tizen.org/appcontrol/operation/dial"; @@ -137,7 +137,7 @@ namespace Tizen.Applications public const string SettingBluetoothEnable = "http://tizen.org/appcontrol/operation/setting/bt_enable"; /// <summary> - /// Shows settings to configure Bluetooth visibility. + /// Shows settings to configure the Bluetooth visibility. /// </summary> public const string SettingBluetoothVisibility = "http://tizen.org/appcontrol/operation/setting/bt_visibility"; diff --git a/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs b/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs index 7318466..8901468 100755 --- a/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs +++ b/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs @@ -24,7 +24,7 @@ namespace Tizen.Applications public class AppControlReceivedEventArgs : EventArgs { /// <summary> - /// Initializes AppControlReceivedEventArgs class. + /// Initializes the AppControlReceivedEventArgs class. /// </summary> /// <param name="appControl"></param> public AppControlReceivedEventArgs(ReceivedAppControl appControl) diff --git a/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs b/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs index 7fed628..86a33d3 100755 --- a/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs +++ b/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs @@ -17,27 +17,27 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for App Control Result. + /// Enumeration for the application control result. /// </summary> public enum AppControlReplyResult { /// <summary> - /// Callee application launched actually + /// The callee application launched actually. /// </summary> AppStarted = 1, /// <summary> - /// Operation is succeeded + /// The operation succeeded. /// </summary> Succeeded = 0, /// <summary> - /// Operation is failed by the callee + /// The operation failed by the callee. /// </summary> Failed = -1, /// <summary> - /// Operation is canceled by the platform + /// The operation canceled by the platform. /// </summary> Canceled = -2, } diff --git a/Tizen.Applications.Common/Tizen.Applications/Application.cs b/Tizen.Applications.Common/Tizen.Applications/Application.cs index 2049f57..5d3077f 100755 --- a/Tizen.Applications.Common/Tizen.Applications/Application.cs +++ b/Tizen.Applications.Common/Tizen.Applications/Application.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// Class that represents a Tizen application. + /// The class that represents a Tizen application. /// </summary> public abstract class Application : IDisposable { @@ -33,12 +33,12 @@ namespace Tizen.Applications private ApplicationInfo _applicationInfo; /// <summary> - /// Gets the instance of current application. + /// Gets the instance of the current application. /// </summary> public static Application Current { get { return s_CurrentApplication; } } /// <summary> - /// Gets the class representing directory information of current application. + /// Gets the class representing directory information of the current application. /// </summary> public DirectoryInfo DirectoryInfo { @@ -56,7 +56,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the class representing information of current application. + /// Gets the class representing information of the current application. /// </summary> public ApplicationInfo ApplicationInfo { @@ -92,7 +92,7 @@ namespace Tizen.Applications } /// <summary> - /// Exits the main loop of application. + /// Exits the main loop of the application. /// </summary> public abstract void Exit(); @@ -120,7 +120,7 @@ namespace Tizen.Applications } /// <summary> - /// Finalizer of the Application class. + /// Finalizer of the application class. /// </summary> ~Application() { @@ -128,7 +128,7 @@ namespace Tizen.Applications } /// <summary> - /// Releases all resources used by the Application class. + /// Releases all resources used by the application class. /// </summary> public void Dispose() { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs index 5b185d3..5197935 100644 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// Arguments for the event that is raised when the application is disabled. + /// Arguments for the event raised when the application is disabled. /// </summary> public class ApplicationDisabledEventArgs : EventArgs { @@ -33,12 +33,12 @@ namespace Tizen.Applications } /// <summary> - /// The Id of the application + /// The ID of the application. /// </summary> public string ApplicationId { get { return _applicationId; } } /// <summary> - /// The Event state of the application + /// The event state of the application. /// </summary> public ApplicationEventState EventState { get { return _eventState; } } } diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs index fa72e8a..297ba83 100644 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// Arguments for the event that is raised when the application is enabled. + /// Arguments for the event raised when the application is enabled. /// </summary> public class ApplicationEnabledEventArgs : EventArgs { @@ -33,12 +33,12 @@ namespace Tizen.Applications } /// <summary> - /// The Id of the application + /// The ID of the application. /// </summary> public string ApplicationId { get { return _applicationId; } } /// <summary> - /// The Event state of the application + /// The event state of the application. /// </summary> public ApplicationEventState EventState { get { return _eventState; } } } diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs index 8ef9597..fff69ea 100644 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs @@ -19,20 +19,20 @@ using System; namespace Tizen.Applications { /// <summary> - /// Enumeration of the application event state + /// Enumeration for the application event state. /// </summary> public enum ApplicationEventState { /// <summary> - /// Processing Started. + /// Processing started. /// </summary> Started = Interop.ApplicationManager.AppManagerEventState.Started, /// <summary> - /// Processing Completed. + /// Processing completed. /// </summary> Completed = Interop.ApplicationManager.AppManagerEventState.Completed, /// <summary> - /// Processing Failed. + /// Processing failed. /// </summary> Failed = Interop.ApplicationManager.AppManagerEventState.Failed } diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs index 34d7b19..a0e7227 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs @@ -41,16 +41,16 @@ namespace Tizen.Applications } /// <summary> - /// A constructor of ApplicationInfo that takes the application id. + /// A constructor of ApplicationInfo that takes the application ID. /// </summary> - /// <param name="applicationId">application id.</param> + /// <param name="applicationId">Application ID.</param> public ApplicationInfo(string applicationId) { _applicationId = applicationId; } /// <summary> - /// Destructor of the class + /// Destructor of the class. /// </summary> ~ApplicationInfo() { @@ -58,7 +58,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the application id. + /// Gets the application ID. /// </summary> public string ApplicationId { @@ -81,7 +81,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the package id of the application. + /// Gets the package ID of the application. /// </summary> public string PackageId { @@ -217,7 +217,7 @@ namespace Tizen.Applications } /// <summary> - /// Checks whether application information is nodisplay. If the application icon is not displayed on the menu screen, true; otherwise, false. + /// Checks whether the application information is nodisplay. If the application icon is not displayed on the menu screen, true; otherwise, false. /// </summary> public bool IsNoDisplay { @@ -239,7 +239,7 @@ namespace Tizen.Applications } /// <summary> - /// Checks whether application is launched on booting time. If the application will be automatically start on boot, true; otherwise, false. + /// Checks whether the application is launched on booting time. If the application automatically starts on boot, true; otherwise, false. /// </summary> public bool IsOnBoot { @@ -260,7 +260,7 @@ namespace Tizen.Applications } /// <summary> - /// Checks whether application is preloaded. If the application is preloaded, true; otherwise, false. + /// Checks whether the application is preloaded. If the application is preloaded, true; otherwise, false. /// </summary> public bool IsPreload { @@ -349,9 +349,9 @@ namespace Tizen.Applications } /// <summary> - /// Gets the localized label of application for the given locale. + /// Gets the localized label of the application for the given locale. /// </summary> - /// <param name="locale">locale.</param> + /// <param name="locale">Locale.</param> public string GetLocalizedLabel(string locale) { string label = string.Empty; diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs index bba97b3..313d30b 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Applications { /// <summary> - /// This class is a parameter of GetInstalledApplicationsAsync method. + /// This class is a parameter of the GetInstalledApplicationsAsync method. /// </summary> public class ApplicationInfoFilter { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs index b4bc005..37abfb7 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Applications { /// <summary> - /// This class is a parameter of GetInstalledApplicationsAsync method. + /// This class is a parameter of the GetInstalledApplicationsAsync method. /// </summary> public class ApplicationInfoMetadataFilter : ApplicationInfoFilter { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs index 7f9c4b7..e80ef39 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// Arguments for the event that is raised when the application is launched. + /// Arguments for the event raised when the application is launched. /// </summary> public class ApplicationLaunchedEventArgs : EventArgs { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs index adc70c3..83fdd54 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs @@ -303,9 +303,9 @@ namespace Tizen.Applications } /// <summary> - /// Gets the information of the specified application with the application id. + /// Gets the information of the specified application with the application ID. /// </summary> - /// <param name="applicationId">Application id.</param> + /// <param name="applicationId">Application ID.</param> public static ApplicationInfo GetInstalledApplication(string applicationId) { IntPtr infoHandle = IntPtr.Zero; @@ -321,7 +321,7 @@ namespace Tizen.Applications /// <summary> /// Returns if the specified application is running or not. /// </summary> - /// <param name="applicationId">The application Id.</param> + /// <param name="applicationId">The application ID.</param> /// <returns>Returns true if the given application is running, otherwise false.</returns> /// <exception cref="ArgumentException">Thrown when the given parameter is invalid.</exception> public static bool IsRunning(string applicationId) @@ -422,8 +422,8 @@ namespace Tizen.Applications /// <summary> /// Gets the information of the recent applications. /// </summary> - /// <returns>Returns a dictionary containing all recent application info.</returns> - /// <exception cref="InvalidOperationException">Thrown when failed because of invalid operation</exception> + /// <returns>Returns a dictionary containing all the recent application info.</returns> + /// <exception cref="InvalidOperationException">Thrown when failed because of an invalid operation.</exception> [EditorBrowsable(EditorBrowsableState.Never)] public static IEnumerable<RecentApplicationInfo> GetRecentApplications() { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs index 73f8608..627c639 100644 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs @@ -36,11 +36,11 @@ namespace Tizen.Applications } /// <summary> - /// A constructor of ApplicationRunningContext that takes the application id. + /// A constructor of ApplicationRunningContext that takes the application ID. /// </summary> - /// <param name="applicationId">application id.</param> - /// <exception cref="ArgumentException">Thrown when failed of invalid argument.</exception> - /// <exception cref="InvalidOperationException">Thrown when failed because of application not exist error or system error.</exception> + /// <param name="applicationId">Application ID.</param> + /// <exception cref="ArgumentException">Thrown when failed because of an invalid argument.</exception> + /// <exception cref="InvalidOperationException">Thrown when failed because of the "application not exist" error or the system error.</exception> /// <exception cref="OutOfMemoryException">Thrown when failed because of out of memory.</exception> public ApplicationRunningContext(string applicationId) { @@ -96,7 +96,7 @@ namespace Tizen.Applications } /// <summary> - /// Destructor of the class + /// Destructor of the class. /// </summary> ~ApplicationRunningContext() { @@ -104,12 +104,12 @@ namespace Tizen.Applications } /// <summary> - /// Enumeration for the Application State. + /// Enumeration for the application state. /// </summary> public enum AppState { /// <summary> - /// The undefined state + /// The undefined state. /// </summary> Undefined = 0, @@ -124,7 +124,7 @@ namespace Tizen.Applications Background, /// <summary> - /// The Service application is running. + /// The service application is running. /// </summary> Service, @@ -135,7 +135,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the application id. + /// Gets the application ID. /// </summary> public string ApplicationId { @@ -152,7 +152,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the package id of the application. + /// Gets the package ID of the application. /// </summary> public string PackageId { @@ -169,7 +169,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the application's process id. + /// Gets the application's process ID. /// </summary> public int ProcessId { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs index 622dc91..360cd93 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// Arguments for the event that is raised when the application is terminated. + /// Arguments for the event raised when the application is terminated. /// </summary> public class ApplicationTerminatedEventArgs : EventArgs { diff --git a/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs b/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs index 857c3a7..de05b86 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for applications type. + /// Enumeration for the applications type. /// </summary> public enum ApplicationType { diff --git a/Tizen.Applications.Common/Tizen.Applications/Bundle.cs b/Tizen.Applications.Common/Tizen.Applications/Bundle.cs index 1b56e8e..0f790ab 100755 --- a/Tizen.Applications.Common/Tizen.Applications/Bundle.cs +++ b/Tizen.Applications.Common/Tizen.Applications/Bundle.cs @@ -24,7 +24,7 @@ using Tizen.Internals.Errors; namespace Tizen.Applications { /// <summary> - /// A Bundle object represents a bundle. + /// A bundle object represents a bundle. /// A bundle holds items (key-value pairs) and can be used with other Tizen APIs. /// Keys can be used to access values. /// This class is accessed by using a constructor to create a new instance of this object. @@ -37,9 +37,9 @@ namespace Tizen.Applications private readonly HashSet<string> _keys; /// <summary> - /// The Bundle constructor. + /// The bundle constructor. /// </summary> - /// <exception cref="System.InvalidOperationException">Thrown when out of memory</exception> + /// <exception cref="System.InvalidOperationException">Thrown when out of memory.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// </code> @@ -51,7 +51,7 @@ namespace Tizen.Applications } /// <summary> - /// The Bundle constructor. + /// The bundle constructor. /// </summary> /// <param name="handle">The SafeBundleHandle instance.</param> /// <exception cref="System.ArgumentNullException">Thrown when the handle is null or invalid.</exception> @@ -94,7 +94,7 @@ namespace Tizen.Applications } /// <summary> - /// The number of items in a Bundle object. + /// The number of items in a bundle object. /// </summary> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); @@ -110,7 +110,7 @@ namespace Tizen.Applications } /// <summary> - /// The keys in a Bundle object. + /// The keys in a bundle object. /// </summary> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); @@ -152,7 +152,7 @@ namespace Tizen.Applications /// Checks whether the bundle contains an item with a specified key. /// </summary> /// <param name="key">The key to check for.</param> - /// <returns>true if the bundle contains the key. false otherwise.</returns> + /// <returns>true if the bundle contains the key, false otherwise.</returns> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// bundle.AddItem("string", "a_string"); @@ -170,11 +170,11 @@ namespace Tizen.Applications /// <summary> /// Adds an item into the bundle. /// </summary> - /// <param name="key">The key to identify the item with. If an item with the key already exists in the Bundle, this method will not succeed.</param> + /// <param name="key">The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed.</param> /// <param name="value">The value of the item.</param> /// <exception cref="System.ArgumentException">Thrown when the key already exists or when there is an invalid parameter.</exception> - /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the Bundle instance has been disposed.</exception> + /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; @@ -192,14 +192,14 @@ namespace Tizen.Applications /// <summary> /// Adds an item into the bundle. /// </summary> - /// <param name="key">The key to identify the item with. If an item with the key already exists in the Bundle, this method will not succeed.</param> + /// <param name="key">The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed.</param> /// <param name="value">The value of the item.</param> /// <param name="offset">The zero-based byte offset in value from which to add to the bundle.</param> /// <param name="count">The maximum number of bytes to add to the bundle starting with offset.</param> /// <exception cref="System.ArgumentOutOfRangeException">Thrown when the offset or count is out of range.</exception> /// <exception cref="System.ArgumentException">Thrown when the key already exists or when there is an invalid parameter.</exception> - /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the Bundle instance has been disposed.</exception> + /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; @@ -243,10 +243,10 @@ namespace Tizen.Applications /// <summary> /// Adds an item into the bundle. /// </summary> - /// <param name="key">The key to identify the item with. If an item with the key already exists in the Bundle, this method will not succeed.</param> + /// <param name="key">The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed.</param> /// <param name="value">The value of the item.</param> /// <exception cref="System.ArgumentException">Thrown when the key already exists or when there is an invalid parameter.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// bundle.AddItem("string", "a_string"); @@ -268,10 +268,10 @@ namespace Tizen.Applications /// <summary> /// Adds an item into the bundle. /// </summary> - /// <param name="key">The key to identify the item with. If an item with the key already exists in the Bundle, this method will not succeed.</param> + /// <param name="key">The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed.</param> /// <param name="value">The value of the item.</param> /// <exception cref="System.ArgumentException">Thrown when the key already exists or when there is an invalid parameter.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// string[] stringArray = { "a", "b", "c" }; @@ -298,7 +298,7 @@ namespace Tizen.Applications /// <param name="key">The key of the bundle item whose value is desired.</param> /// <returns>The value of the bundle item.</returns> /// <exception cref="System.ArgumentException">Thrown when the key does not exist or when there is an invalid parameter.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// bundle.AddItem("string", "a_string"); @@ -368,7 +368,7 @@ namespace Tizen.Applications /// <returns>The value of the bundle item if it is of the specified generic type.</returns> /// <exception cref="System.ArgumentException">Thrown when the key does not exist or when there is an invalid parameter.</exception> /// <exception cref="System.InvalidCastException">Thrown when the value of the bundle item cannot be converted to the specified generic type.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// string[] stringArray = { "a", "b", "c" }; @@ -398,8 +398,8 @@ namespace Tizen.Applications /// </summary> /// <param name="key">The key of the bundle item whose value is desired.</param> /// <param name="value">The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type.</param> - /// <returns>true if an item with the key exists and if the value is the same type as the output value parameter. false otherwise.</returns> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <returns>true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise.</returns> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; @@ -433,8 +433,8 @@ namespace Tizen.Applications /// </summary> /// <param name="key">The key of the bundle item whose value is desired.</param> /// <param name="value">The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type.</param> - /// <returns>true if an item with the key exists and if the value is the same type as the output value parameter. false otherwise.</returns> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <returns>true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise.</returns> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// bundle.AddItem("string", "a_string"); @@ -467,8 +467,8 @@ namespace Tizen.Applications /// </summary> /// <param name="key">The key of the bundle item whose value is desired.</param> /// <param name="value">The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type.</param> - /// <returns>true if an item with the key exists and if the value is the same type as the output value parameter. false otherwise.</returns> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <returns>true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise.</returns> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// string[] stringArray = { "a", "b", "c" }; @@ -505,9 +505,9 @@ namespace Tizen.Applications /// </summary> /// <typeparam name="T">The generic type to check for.</typeparam> /// <param name="key">The key whose type wants to be checked.</param> - /// <returns>true if the item is of the specified type. false otherwise.</returns> + /// <returns>true if the item is of the specified type, false otherwise.</returns> /// <exception cref="System.ArgumentException">Thrown when the key does not exist or when there is an invalid parameter.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// string[] stringArray = { "a", "b", "c" }; @@ -549,12 +549,12 @@ namespace Tizen.Applications } /// <summary> - /// Removes a a bundle item with a specific key from a Bundle. + /// Removes a bundle item with a specific key from a Bundle. /// </summary> /// <param name="key">The key of the item to delete.</param> - /// <returns>true if the item is successfully found and removed. false otherwise (even if the item is not found).</returns> + /// <returns>true if the item is successfully found and removed, false otherwise (even if the item is not found).</returns> /// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// bundle.AddItem("string", "a_string"); @@ -588,7 +588,7 @@ namespace Tizen.Applications /// <summary> /// Decodes an encoded bundle data. /// </summary> - /// <param name="bundleRaw">The encoded bundle data. bundleRaw should be return value of Tizen.Applications.Bundle.Encode, otherwise this method will not succeed</param> + /// <param name="bundleRaw">The encoded bundle data. bundleRaw should be the returned value of Tizen.Applications.Bundle.Encode, otherwise this method will not succeed.</param> /// <returns>Decoded Bundle object.</returns> /// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception> /// <code> @@ -612,8 +612,8 @@ namespace Tizen.Applications /// <summary> /// Encodes bundle to string. /// </summary> - /// <returns>Encoded Bundle data in string.</returns> - /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the Bundle instance has been disposed.</exception> + /// <returns>Encoded bundle data in string.</returns> + /// <exception cref="System.InvalidOperationException">Thrown when out of memory or when the bundle instance has been disposed.</exception> /// <code> /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// string bundleRaw = bundle.Encode(); @@ -651,7 +651,7 @@ namespace Tizen.Applications } /// <summary> - /// Destructor of the Bundle class. + /// Destructor of the bundle class. /// </summary> ~Bundle() { diff --git a/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs b/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs index 5bf6e39..d725a78 100755 --- a/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs +++ b/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs @@ -21,7 +21,7 @@ using Tizen.Applications.CoreBackend; namespace Tizen.Applications { /// <summary> - /// Class that represents an application controlled lifecycles by the backend system. + /// This class represents an application controlled lifecycles by the backend system. /// </summary> public class CoreApplication : Application { diff --git a/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs b/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs index 5b41aea..19a8f21 100755 --- a/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs +++ b/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs @@ -17,27 +17,27 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for device orientation. + /// Enumeration for the device orientation. /// </summary> public enum DeviceOrientation { /// <summary> - /// The device orientation is 0 + /// The device orientation is 0. /// </summary> Orientation_0 = 0, /// <summary> - /// The device orientation is 90 + /// The device orientation is 90. /// </summary> Orientation_90 = 90, /// <summary> - /// The device orientation is 180 + /// The device orientation is 180. /// </summary> Orientation_180 = 180, /// <summary> - /// The device orientation is 270 + /// The device orientation is 270. /// </summary> Orientation_270 = 270, } diff --git a/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs b/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs index 750e316..63bb8ea 100755 --- a/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs +++ b/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs @@ -19,12 +19,12 @@ using System; namespace Tizen.Applications { /// <summary> - /// The class for the argument of the DeviceOrientationChanged EventHandler + /// The class for event arguments of the DeviceOrientationChanged. /// </summary> public class DeviceOrientationEventArgs : EventArgs { /// <summary> - /// Initializes DeviceOrientationEventArgs class + /// Initializes the DeviceOrientationEventArgs class. /// </summary> /// <param name="orientation">The information of the DeviceOrientation</param> public DeviceOrientationEventArgs(DeviceOrientation orientation) @@ -33,8 +33,8 @@ namespace Tizen.Applications } /// <summary> - /// The property to get the intformation of the DeviceOrientation + /// The received DeviceOrientation. /// </summary> public DeviceOrientation DeviceOrientation { get; private set; } } -}
\ No newline at end of file +} diff --git a/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs b/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs index 4b7f06b..0166fc1 100755 --- a/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs +++ b/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs @@ -40,7 +40,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's data directory which is used to store private data of the application. + /// Gets the absolute path to the application's data directory, which is used to store private data of the application. /// </summary> public string Data { @@ -53,7 +53,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's cache directory which is used to store temporary data of the application. + /// Gets the absolute path to the application's cache directory, which is used to store temporary data of the application. /// </summary> public string Cache { @@ -79,7 +79,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's shared data directory which is used to share data with other applications. + /// Gets the absolute path to the application's shared data directory, which is used to share data with other applications. /// </summary> public string SharedData { @@ -92,7 +92,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's shared resource directory which is used to share resources with other applications. + /// Gets the absolute path to the application's shared resource directory, which is used to share resources with other applications. /// </summary> public string SharedResource { @@ -106,7 +106,7 @@ namespace Tizen.Applications /// <summary> - /// Gets the absolute path to the application's shared trusted directory which is used to share data with a family of trusted applications. + /// Gets the absolute path to the application's shared trusted directory, which is used to share data with a family of trusted applications. /// </summary> public string SharedTrusted { @@ -119,7 +119,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's external data directory which is used to store data of the application. + /// Gets the absolute path to the application's external data directory, which is used to store data of the application. /// </summary> public string ExternalData { @@ -132,7 +132,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's external cache directory which is used to store temporary data of the application. + /// Gets the absolute path to the application's external cache directory, which is used to store temporary data of the application. /// </summary> public string ExternalCache { @@ -145,7 +145,7 @@ namespace Tizen.Applications } /// <summary> - /// Gets the absolute path to the application's external shared data directory which is used to share data with other applications. + /// Gets the absolute path to the application's external shared data directory, which is used to share data with other applications. /// </summary> public string ExternalSharedData { diff --git a/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs b/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs index a835521..d9d2184 100755 --- a/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs +++ b/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs @@ -17,22 +17,22 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for low battery status. + /// Enumeration for the low battery status. /// </summary> public enum LowBatteryStatus { /// <summary> - /// + /// /// </summary> None = 0, /// <summary> - /// The battery status is under 1% + /// The battery status is under 1%. /// </summary> PowerOff = 1, /// <summary> - /// The battery status is under 5% + /// The battery status is under 5%. /// </summary> CriticalLow } diff --git a/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs b/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs index e704de3..e584add 100755 --- a/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs +++ b/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs @@ -17,27 +17,27 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for low memory status. + /// Enumeration for the low memory status. /// </summary> public enum LowMemoryStatus { /// <summary> - /// Not initialized status + /// Not initialized status. /// </summary> None = 0x00, /// <summary> - /// Normal status + /// Normal status. /// </summary> Normal = 0x01, /// <summary> - /// Soft warning status + /// Soft warning status. /// </summary> SoftWarning = 0x02, /// <summary> - /// Hard warning status + /// Hard warning status. /// </summary> HardWarning = 0x04, } diff --git a/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs b/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs index 638ee7a..f639ef3 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs @@ -58,7 +58,7 @@ namespace Tizen.Applications /// Gets the application ID of the caller from the launch request. /// </summary> /// <value> - /// The application ID of the caller + /// The application ID of the caller. /// </value> /// <example> /// <code> @@ -87,7 +87,7 @@ namespace Tizen.Applications /// Checks whether the caller is requesting a reply from the launch request. /// </summary> /// <value> - /// If true this ReceivedAppControl is requested by the caller, otherwise false + /// If true, this ReceivedAppControl is requested by the caller, otherwise false /// </value> /// <example> /// <code> @@ -114,10 +114,10 @@ namespace Tizen.Applications /// <summary> /// Replies to the launch request sent by the caller. - /// If the caller application sent the launch request to receive the result, the callee application can return the result back to the caller. + /// If the caller application sends the launch request to receive the result, the callee application can return the result back to the caller. /// </summary> - /// <param name="replyRequest">The AppControl in which the results of the callee are contained</param> - /// <param name="result">The result code of the launch request</param> + /// <param name="replyRequest">The AppControl in which the results of the callee are contained.</param> + /// <param name="result">The result code of the launch request.</param> /// <example> /// <code> /// protected override void OnAppControlReceived(AppControlReceivedEventArgs e) diff --git a/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs b/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs index 5bc84fe..19f9bb7 100755 --- a/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs +++ b/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs @@ -22,7 +22,7 @@ using System.Runtime.InteropServices; namespace Tizen.Applications { /// <summary> - /// This class provides methods and properties to get information of recent application. + /// This class provides methods and properties to get information of the recent application. /// </summary> [EditorBrowsable(EditorBrowsableState.Never)] public class RecentApplicationControl @@ -37,7 +37,7 @@ namespace Tizen.Applications } /// <summary> - /// Deletes the application from recent application list. + /// Deletes the application from the recent application list. /// </summary> /// <privlevel>platform</privlevel> public void Delete() @@ -51,7 +51,7 @@ namespace Tizen.Applications } /// <summary> - /// Delete all recent applicationsfrom recent application list. + /// Deletes all recent applications from the recent application list. /// </summary> /// <privlevel>platform</privlevel> public static void DeleteAll() diff --git a/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs b/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs index 613e7d6..6ffc644 100755 --- a/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs +++ b/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs @@ -21,7 +21,7 @@ using System.Runtime.InteropServices; namespace Tizen.Applications { /// <summary> - /// This class provides methods and properties to get information of recent application. + /// This class provides methods and properties to get information of the recent application. /// </summary> [EditorBrowsable(EditorBrowsableState.Never)] public class RecentApplicationInfo : ApplicationInfo @@ -29,12 +29,12 @@ namespace Tizen.Applications private const string LogTag = "Tizen.Applications"; /// <summary> - /// Gets the instance id. + /// Gets the instance ID. /// </summary> public string InstanceId { get; private set; } /// <summary> - /// Gets the instance Name. + /// Gets the instance name. /// </summary> public string InstanceName { get; private set; } @@ -44,7 +44,7 @@ namespace Tizen.Applications public string Arg { get; private set; } /// <summary> - /// Gets the uri. + /// Gets the URI. /// </summary> public string Uri { get; private set; } diff --git a/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs b/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs index c20840a..3212fac 100755 --- a/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs +++ b/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs @@ -20,12 +20,12 @@ using Tizen.Internals.Errors; namespace Tizen.Applications { /// <summary> - /// Class for getting resource path. + /// The class for getting the resource path. /// </summary> public static class ResourceManager { /// <summary> - /// Enumeration for Resource category. + /// Enumeration for the resource category. /// </summary> public enum Category : int { @@ -69,12 +69,12 @@ namespace Tizen.Applications } /// <summary> - /// Converts resource ID to path name. + /// Converts resource ID to the path name. /// </summary> - /// <param name="category">Category to search</param> - /// <param name="id">ID to search</param> - /// <returns>Found resource path</returns> - /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception> + /// <param name="category">Category to search.</param> + /// <param name="id">ID to search.</param> + /// <returns>Found resource path.</returns> + /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception> public static string GetPath(Category category, string id) { string path; @@ -96,12 +96,12 @@ namespace Tizen.Applications } /// <summary> - /// Converts resource ID to path name. + /// Converts resource ID to the path name. /// </summary> - /// <param name="category">Category to search</param> - /// <param name="id">ID to search</param> - /// <returns>Found resource path or null when the resource doesn't exist</returns> - /// <exception cref="InvalidOperationException">Thrown in case of failed conditions</exception> + /// <param name="category">Category to search.</param> + /// <param name="id">ID to search.</param> + /// <returns>Found resource path or null when the resource doesn't exist.</returns> + /// <exception cref="InvalidOperationException">Thrown in case of failed conditions.</exception> public static string TryGetPath(Category category, string id) { string path; diff --git a/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs b/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs index 5bbdf60..50006f5 100755 --- a/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs +++ b/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs @@ -20,7 +20,7 @@ using System.Runtime.InteropServices; namespace Tizen.Applications { /// <summary> - /// Represents a wrapper class for a unmanaged AppControl handle. + /// Represents a wrapper class for an unmanaged AppControl handle. /// </summary> public sealed class SafeAppControlHandle : SafeHandle { @@ -52,7 +52,7 @@ namespace Tizen.Applications /// <summary> /// When overridden in a derived class, executes the code required to free the handle. /// </summary> - /// <returns>true if the handle is released successfully</returns> + /// <returns>true if the handle is released successfully.</returns> protected override bool ReleaseHandle() { Interop.AppControl.DangerousDestroy(this.handle); diff --git a/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs b/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs index c3bab4b..7da7f27 100755 --- a/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs +++ b/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs @@ -20,7 +20,7 @@ using System.Runtime.InteropServices; namespace Tizen.Applications { /// <summary> - /// Represents a wrapper class for a unmanaged Bundle handle. + /// Represents a wrapper class for an unmanaged bundle handle. /// </summary> public sealed class SafeBundleHandle : SafeHandle { @@ -52,7 +52,7 @@ namespace Tizen.Applications /// <summary> /// When overridden in a derived class, executes the code required to free the handle. /// </summary> - /// <returns>true if the handle is released successfully</returns> + /// <returns>true if the handle is released successfully.</returns> protected override bool ReleaseHandle() { Interop.Bundle.DangerousFree(this.handle); diff --git a/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs b/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs index dcfb4c8..df29950 100644 --- a/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs +++ b/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs @@ -40,10 +40,10 @@ namespace Tizen.Applications } /// <summary> - /// Initilizes a new TizenSynchronizationContext and install into current thread + /// Initilizes a new TizenSynchronizationContext and install into the current thread. /// </summary> /// <remarks> - /// It is equivalent + /// It is equivalent. /// <code> /// SetSynchronizationContext(new TizenSynchronizationContext()); /// </code> @@ -60,7 +60,7 @@ namespace Tizen.Applications /// <param name="d"><see cref="System.Threading.SendOrPostCallback"/>The SendOrPostCallback delegate to call.</param> /// <param name="state"><see cref="System.Object"/>The object passed to the delegate.</param> /// <remarks> - /// The Post method starts an asynchronous request to post a message.</remarks> + /// The post method starts an asynchronous request to post a message.</remarks> public override void Post(SendOrPostCallback d, object state) { Post(() => @@ -70,12 +70,12 @@ namespace Tizen.Applications } /// <summary> - /// Dispatches a synchronous message to a Tizen main loop + /// Dispatches a synchronous message to a Tizen main loop. /// </summary> /// <param name="d"><see cref="System.Threading.SendOrPostCallback"/>The SendOrPostCallback delegate to call.</param> /// <param name="state"><see cref="System.Object"/>The object passed to the delegate.</param> /// <remarks> - /// The Send method starts a synchronous request to send a message.</remarks> + /// The send method starts a synchronous request to send a message.</remarks> public override void Send(SendOrPostCallback d, object state) { var mre = new ManualResetEvent(false); diff --git a/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs b/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs index 26632e4..c92362a 100755 --- a/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs +++ b/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs @@ -21,10 +21,10 @@ using Tizen.Applications; namespace Tizen.Applications.Messages { /// <summary> - /// The Message Port API provides functions to send and receive messages between applications. + /// The message port API provides functions to send and receive messages between applications. /// </summary> /// <remarks> - /// The Message Port API provides functions for passing messages between applications. An application should register its own local port to receive messages from remote applications. + /// The message port API provides functions for passing messages between applications. An application should register its own local port to receive messages from remote applications. /// If a remote application sends a message, the registered callback function of the local port is called. /// The trusted message-port API allows communications between applications that are signed by the same developer(author) certificate. /// </remarks> @@ -50,9 +50,9 @@ namespace Tizen.Applications.Messages /// <summary> /// Initializes the instance of the MessagePort class. /// </summary> - /// <param name="portName">The name of the local message port</param> - /// <param name="trusted">If true is the trusted message port of application, otherwise false</param> - /// <exception cref="System.InvalidOperationException">Thrown when portName is null or empty</exception> + /// <param name="portName">The name of the local message port.</param> + /// <param name="trusted">If true, it is the trusted message port of application, otherwise false.</param> + /// <exception cref="System.InvalidOperationException">Thrown when portName is null or empty.</exception> /// <code> /// MessagePort messagePort = new MessagePort("SenderPort", true); /// </code> @@ -91,7 +91,7 @@ namespace Tizen.Applications.Messages public event EventHandler<MessageReceivedEventArgs> MessageReceived; /// <summary> - /// The name of the local message port + /// The name of the local message port. /// </summary> public string PortName { @@ -101,7 +101,7 @@ namespace Tizen.Applications.Messages } } /// <summary> - /// If true the message port is a trusted port, otherwise false it is not + /// If true, the message port is a trusted port, otherwise false. /// </summary> public bool Trusted { @@ -112,7 +112,7 @@ namespace Tizen.Applications.Messages } /// <summary> - /// If true the message port is listening, otherwise false it is not + /// If true, the message port is listening, otherwise false. /// </summary> public bool Listening { @@ -125,7 +125,7 @@ namespace Tizen.Applications.Messages /// <summary> /// Register the local message port. /// </summary> - /// <exception cref="System.InvalidOperationException">Thrown when portName is already used, when there is an invalid parameter, when out of memory, when there is an I/O error</exception> + /// <exception cref="System.InvalidOperationException">Thrown when portName is already used, when there is an invalid parameter, when out of memory, when there is an I/O error.</exception> /// <code> /// MessagePort messagePort = new MessagePort("SenderPort", true); /// messagePort.MessageReceived += MessageReceivedCallback; @@ -173,7 +173,7 @@ namespace Tizen.Applications.Messages /// <summary> /// Unregisters the local message port. /// </summary> - /// <exception cref="System.InvalidOperationException">Thrown when messageport is already stopped, when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error</exception> + /// <exception cref="System.InvalidOperationException">Thrown when messageport is already stopped, when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error.</exception> /// <code> /// MessagePort messagePort = new MessagePort("SenderPort", true); /// messagePort.MessageReceived += MessageReceivedCallback; @@ -210,13 +210,13 @@ namespace Tizen.Applications.Messages } /// <summary> - /// Sends a untrusted message to the message port of a remote application. + /// Sends an untrusted message to the message port of a remote application. /// </summary> - /// <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB</param> - /// <param name="remoteAppId">The ID of the remote application</param> - /// <param name="remotePortName">The name of the remote message port</param> - /// <exception cref="System.InvalidOperationException">Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error</exception> - /// <exception cref="System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB)</exception> + /// <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param> + /// <param name="remoteAppId">The ID of the remote application.</param> + /// <param name="remotePortName">The name of the remote message port.</param> + /// <exception cref="System.InvalidOperationException">Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error.</exception> + /// <exception cref="System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception> /// <code> /// MessagePort messagePort = new MessagePort("SenderPort", true); /// messagePort.MessageReceived += MessageReceivedCallback; @@ -235,12 +235,12 @@ namespace Tizen.Applications.Messages /// <summary> /// Sends a message to the message port of a remote application. /// </summary> - /// <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB</param> - /// <param name="remoteAppId">The ID of the remote application</param> - /// <param name="remotePortName">The name of the remote message port</param> - /// <param name="trusted">If true the trusted message port of remote application otherwise false</param> - /// <exception cref="System.InvalidOperationException">Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error</exception> - /// <exception cref="System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB)</exception> + /// <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param> + /// <param name="remoteAppId">The ID of the remote application.</param> + /// <param name="remotePortName">The name of the remote message port.</param> + /// <param name="trusted">If true, it is the trusted message port of remote application, otherwise false.</param> + /// <exception cref="System.InvalidOperationException">Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error.</exception> + /// <exception cref="System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception> /// <code> /// MessagePort messagePort = new MessagePort("SenderPort", true); /// messagePort.MessageReceived += MessageReceivedCallback; @@ -276,7 +276,7 @@ namespace Tizen.Applications.Messages } /// <summary> - /// Releases the unmanaged resourced used by the MessagePort class specifying whether to perform a normal dispose operation. + /// Releases the unmanaged resource used by the MessagePort class specifying whether to perform a normal dispose operation. /// </summary> /// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param> protected virtual void Dispose(bool disposing) diff --git a/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs b/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs index cfe1762..1f4924b 100755 --- a/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs +++ b/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs @@ -18,17 +18,17 @@ using System; namespace Tizen.Applications.Messages { /// <summary> - /// An extended EventArgs class which contains remote message port information and message + /// An extended EventArgs class, which contains remote message port information and message. /// </summary> public class MessageReceivedEventArgs : EventArgs { /// <summary> - /// Contains AppId, Port Name, Trusted + /// Contains AppId, port name, and trusted. /// </summary> public RemoteValues Remote { get; internal set; } /// <summary> - /// The message passed from the remote application + /// The message passed from the remote application. /// </summary> public Bundle Message { get; internal set; } } diff --git a/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs b/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs index db853d3..e1b4b3b 100755 --- a/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs +++ b/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs @@ -17,22 +17,22 @@ namespace Tizen.Applications.Messages { /// <summary> - /// Contains AppId, Port Name, Trusted + /// Contains AppId, port name, and trusted. /// </summary> public class RemoteValues { /// <summary> - /// The ID of the remote application that sent this message + /// The ID of the remote application that sent this message. /// </summary> public string AppId { get; set; } /// <summary> - /// The name of the remote message port + /// The name of the remote message port. /// </summary> public string PortName { get; set; } /// <summary> - /// If true the remote port is a trusted port, otherwise if false it is not + /// If true, the remote port is a trusted port, otherwise, if false, it is not. /// </summary> public bool Trusted { get; set; } } diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs index d0f9c7f..3064dca 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs @@ -21,7 +21,7 @@ namespace Tizen.Applications.Notifications using System.ComponentModel; /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -49,51 +49,51 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Gets or sets Tag of Notification. + /// Gets or sets the tag of notification. /// </summary> public string Tag { get; set; } = string.Empty; /// <summary> - /// Gets or sets Title of Notification. + /// Gets or sets the title of notification. /// </summary> public string Title { get; set; } = string.Empty; /// <summary> - /// Gets or sets icon of Notification. - /// An absolute path for an image file. + /// Gets or sets the icon of notification. + /// You should set an absolute path for an image file. /// </summary> public string Icon { get; set; } = string.Empty; /// <summary> - /// Gets or sets sub icon of Notification. - /// An absolute path for an image file. - /// The SubIcon is superimposed on the lower right of the icon. + /// 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> public string SubIcon { get; set; } = string.Empty; /// <summary> - /// Gets or sets content of Notification. + /// Gets or sets the content of notification. /// </summary> public string Content { get; set; } = string.Empty; /// <summary> - /// Gets or sets a value indicating whether TimeStamp of Notification is Visible or not. + /// Gets or sets a value indicating whether TimeStamp of the notification is Visible or not. /// Default to true. /// </summary> public bool IsTimeStampVisible { get; set; } = true; /// <summary> - /// Gets or sets TimeStamp of Notification. + /// Gets or sets the TimeStamp of notification. /// </summary> /// <remarks> - /// If you don't set TimeStamp, It will be set value that time when the notification is posted. + /// 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 is false, TimeStamp is not Visible in Notification. + /// If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification. /// </remarks> public DateTime TimeStamp { get; set; } /// <summary> - /// Gets or sets Action which is invoked when notification is clicked + /// 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. @@ -102,13 +102,13 @@ namespace Tizen.Applications.Notifications public AppControl Action { get; set; } /// <summary> - /// Gets or sets Count which is displayed at the right side of notification. + /// 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 throw exception. + /// If you set count to negative number, this property throws exception. /// </remarks> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public int Count { get @@ -132,19 +132,19 @@ namespace Tizen.Applications.Notifications public bool IsOngoing { get; set; } = false; /// <summary> - /// Gets or sets property + /// Gets or sets property. /// </summary> /// <seealso cref="Tizen.Applications.Notifications.NotificationProperty"></seealso> public NotificationProperty Property { get; set; } = NotificationProperty.None; /// <summary> - /// Gets or sets <see cref="Notification.ProgressType"/> object for display at notification + /// Gets or sets <see cref="Notification.ProgressType"/> object for display at notification. /// </summary> /// <seealso cref="Tizen.Applications.Notifications.Notification.ProgressType"></seealso> public ProgressType Progress { get; set; } /// <summary> - /// Gets or sets <see cref="Notification.AccessorySet"/> which is included vibration, led and sound option to be applied at Notification. + /// Gets or sets <see cref="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. @@ -178,13 +178,13 @@ namespace Tizen.Applications.Notifications public AccessorySet Accessory { get; set; } /// <summary> - /// Gets or sets a value indicating whether notification is displayed on default viewer. - /// If you set false and add style, It will be shown only on the style you added. + /// 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> public bool IsVisible { get; set; } = true; /// <summary> - /// Gets or sets NotificationSafeHandle + /// Gets or sets NotificationSafeHandle. /// </summary> internal NotificationSafeHandle Handle { @@ -206,19 +206,19 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Gets or sets Private ID + /// Gets or sets private ID. /// </summary> internal int PrivID { get; set; } = -1; /// <summary> - /// Method to add various style to be applied to notification. + /// Method for adding various styles to be applied to notification. /// </summary> /// <remarks> - /// The user always see about valid notification style. If you add style which is not supported in platform, + /// 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="ArgumentException">Thrown when argument is invalid</exception> + /// <param name="style">The style to be applied to notification.</param> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> /// <example> /// <code> /// Notification notification = new Notification @@ -262,8 +262,8 @@ namespace Tizen.Applications.Notifications /// <summary> /// Method to remove style you already added. /// </summary> - /// <typeparam name="T">Type of notification style to be queried</typeparam> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <typeparam name="T">Type of notification style to be queried.</typeparam> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public void RemoveStyle<T>() where T : Notification.StyleBase, new() { T type = new T(); @@ -282,11 +282,11 @@ namespace Tizen.Applications.Notifications /// <summary> /// Method to get style you already added. /// </summary> - /// <typeparam name="T">Type of notification style to be queried</typeparam> + /// <typeparam name="T">Type of notification style to be queried.</typeparam> /// <returns> - /// The Notification.Style object associated with the given style + /// The Notification.Style object associated with the given style. /// </returns> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public T GetStyle<T>() where T : Notification.StyleBase, new() { T type = new T(); @@ -306,14 +306,14 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Method to set extra data to add extra data + /// Method to set extra data to add extra data. /// </summary> /// <remarks> - /// The type of extra data is Bundle. + /// 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="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> /// <example> /// <code> /// Notification notification = new Notification @@ -352,10 +352,10 @@ namespace Tizen.Applications.Notifications /// Method to remove extra you already added. /// </summary> /// <remarks> - /// The type of extra data is Bundle. + /// The type of extra data is bundle. /// </remarks> /// <param name="key">The key of the extra data to add.</param> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public void RemoveExtraData(string key) { if (string.IsNullOrEmpty(key)) @@ -374,11 +374,11 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Method to get extra data you already set + /// 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="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public Bundle GetExtraData(string key) { if (string.IsNullOrEmpty(key)) diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs index 948c8de..ef94ada 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs @@ -19,7 +19,7 @@ namespace Tizen.Applications.Notifications using Tizen.Common; /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -29,7 +29,7 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// Class for Notification AccessorySet which is included vibration, led, sound option + /// Class for notification AccessorySet, which includes vibration, LED, and sound option. /// </summary> public sealed class AccessorySet : MakerBase { @@ -43,12 +43,12 @@ namespace Tizen.Applications.Notifications /// <summary> /// Gets or sets the sound path, It will play on the sound file you set. - /// An absolute path for a sound file. + /// You should set an absolute path for a sound file. /// </summary> public string SoundPath { get; set; } /// <summary> - /// Gets or sets a value indicating whether vibration is operated. Default to false. + /// Gets or sets a value indicating whether vibration is operated. Default is false. /// </summary> public bool CanVibrate { get; set; } = false; @@ -80,10 +80,10 @@ namespace Tizen.Applications.Notifications public int LedOffMillisecond { get; set; } /// <summary> - /// Gets or sets the led color that you would like the LED on the device to blink. + /// 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 is AccessoryOption.Custom. Otherwise, it may operate default led color. + /// If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color. /// </remarks> public Color LedColor { get; set; } diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs index 005e508..66a7163 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs @@ -19,7 +19,7 @@ namespace Tizen.Applications.Notifications using System.Collections.Generic; /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -29,7 +29,7 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// Class for generating Active style notification + /// Class for generating active style notification. /// </summary> public sealed class ActiveStyle : StyleBase { @@ -46,7 +46,7 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Gets or sets an absolute path for an image file to display on the background of active notification + /// Gets or sets an absolute path for an image file to display on the background of active notification. /// </summary> public string BackgroundImage { get; set; } @@ -54,18 +54,18 @@ namespace Tizen.Applications.Notifications /// 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 be removed several seconds after it shows. + /// 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 - /// the active notification or the app which posted the active notification removes the active notification. + /// it or the application, which posted the active notification. /// </remarks>> public bool IsAutoRemove { get; set; } = true; /// <summary> - /// Gets or sets the default button to display highlight on the active notification + /// 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 Tizen TV. - /// If you use this Property on other profile, this value have no effect + /// 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> public ButtonIndex DefaultButton { get; set; } = ButtonIndex.None; @@ -74,7 +74,7 @@ namespace Tizen.Applications.Notifications /// </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 disappeared. + /// If you set null parameter, ReplyAction is not displayed. /// </remarks> /// <example> /// <code> @@ -146,7 +146,7 @@ namespace Tizen.Applications.Notifications public AppControl HiddenByExternalAction { get; set; } /// <summary> - /// Gets the key of ActiveStyle + /// Gets the key of ActiveStyle. /// </summary> internal override string Key { @@ -157,15 +157,15 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Method to set times to hide or delete notification. + /// Method to set time to hide or delete notification. /// </summary> /// <remarks> - /// The time settings for hiding and deleting are only reflected on Tizen TV. - /// If you use this API on other profile, this time settings have no effect + /// 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 second when the notification can be hidden from the notification viewer after notification is posted</param> - /// <param name="deleteTime">The value in second 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> + /// <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> public void SetRemoveTime(int hideTime, int deleteTime) { if (hideTime < 0 || deleteTime < 0) @@ -178,10 +178,10 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Method to get times to hide or delete notification. + /// Method to get time set to hide or delete notification. /// </summary> - /// <param name="hideTime">The value in second when the notification can be hidden from the notification viewer after notification is posted</param> - /// <param name="deleteTime">The value in second when the notification can be deleted from the notification list in setting application after notification is posted</param> + /// <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> public void GetRemoveTime(out int hideTime, out int deleteTime) { hideTime = hideTimeout; @@ -196,8 +196,8 @@ namespace Tizen.Applications.Notifications /// 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">An ButtonAction for appear to the notification</param> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <param name="button">A ButtonAction for appear to the notification.</param> + /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception> /// <example> /// <code> /// @@ -242,10 +242,10 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Remove the ButtonAction you already add. + /// 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> + /// <param name="index">The index to remove a button.</param> + /// <returns>true if the element is successfully found and removed; otherwise, false.</returns> public bool RemoveButtonAction(ButtonIndex index) { bool ret = buttonDictionary.Remove(index); @@ -265,9 +265,9 @@ namespace Tizen.Applications.Notifications /// <summary> /// Gets the ButtonAction of the active notification. /// </summary> - /// <param name="index">The index to get a button you already add</param> - /// <returns>The ButtonAction object which is you already add</returns> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <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> public ButtonAction GetButtonAction(ButtonIndex index) { ButtonAction button = null; @@ -295,4 +295,4 @@ namespace Tizen.Applications.Notifications } } } -}
\ No newline at end of file +} diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs index c291e82..1c87041 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.Notifications { /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -27,34 +27,34 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// Class to help you set button on Active style of Notification + /// 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 user select the button. + /// It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button. /// </remarks>> public sealed class ButtonAction : MakerBase { /// <summary> - /// Gets or sets the index of Button which is appeared at Notification. + /// Gets or sets the index of the button, which appeares as notification. /// </summary> public ButtonIndex Index { get; set; } = ButtonIndex.None; /// <summary> - /// Gets or sets the text describing the button + /// Gets or sets the text describing the button. /// </summary> public string Text { get; set; } /// <summary> - /// Gets or sets the image path that represent the button - /// An absolute path for an image file. + /// Gets or sets the image path that represents the button. + /// You should provide an absolute path for an image file. /// </summary> public string ImagePath { get; set; } /// <summary> - /// Gets or sets the action which is invoked when button is clicked + /// Gets or sets the action, which is invoked when the button is clicked. /// </summary> /// <value> - /// If you don't set Action, nothing happens when button is clicked. + /// If you don't set action, nothing happens when the button is clicked. /// </value> /// <example> /// <code> diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs index 459bfd4..877eba3 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs @@ -19,122 +19,122 @@ namespace Tizen.Applications.Notifications using System; /// <summary> - /// Enumeration for Progress category + /// Enumeration for the progress category. /// </summary> public enum ProgressCategory { /// <summary> - /// Value for percent type + /// Value for percent type. /// </summary> Percent, /// <summary> - /// Value for time type + /// Value for time type. /// </summary> Time, /// <summary> - /// Value for pending type which is not updated progress current value + /// Value for pending type, which is not the updated progress current value. /// </summary> PendingBar } /// <summary> - /// Enumeration for Accessory option + /// Enumeration for the accessory option. /// </summary> public enum AccessoryOption { /// <summary> - /// Value for off accessory option + /// Value for off accessory option. /// </summary> Off = -1, /// <summary> - /// Value for on accessory option + /// Value for on accessory option. /// </summary> On, /// <summary> - /// Value for custom accessory option + /// Value for the custom accessory option. /// </summary> Custom } /// <summary> - /// Enumeration for Button Index + /// Enumeration for the button index. /// </summary> public enum ButtonIndex { /// <summary> - /// Value for default button index + /// Value for the default button index. /// </summary> None = -1, /// <summary> - /// Value for first button index + /// Value for the first button index. /// </summary> First, /// <summary> - /// Value for second button index + /// Value for the second button index. /// </summary> Second, /// <summary> - /// Value for third button index + /// Value for the third button index. /// </summary> Third } /// <summary> - /// Enumeration for notification particular property + /// Enumeration for the notification particular property. /// </summary> [Flags] public enum NotificationProperty { /// <summary> - /// Value for adjust nothing + /// Value for adjust nothing. /// </summary> None = 0x00, /// <summary> - /// Value for display only SIM card inserted + /// Value for display only SIM card inserted. /// </summary> DisplayOnlySimMode = 0x01, /// <summary> - /// Value for disable application launch when it selected + /// Value for disable application launch when it is selected. /// </summary> DisableAppLaunch = 0x02, /// <summary> - /// Value for disable auto delete when it selected + /// Value for disable auto delete when it is selected. /// </summary> DisableAutoDelete = 0x04, /// <summary> - /// Value for deleted when device is rebooted even though notification is not set Ongoing + /// Value for deleted when device is rebooted even though notification is not set ongoing. /// </summary> VolatileDisplay = 0x100 } /// <summary> - /// Enumeration for block state + /// Enumeration for the block state. /// </summary> public enum NotificationBlockState { /// <summary> - /// Value to check the app is allowed to post notification + /// Value to check if the app is allowed to post notification. /// </summary> Allowed = 0, /// <summary> - /// Value to check the app is not allowed to post any notification + /// Value to check if the app is not allowed to post any notification. /// </summary> Blocked, /// <summary> - /// Value to check do not disturb mode which is user set + /// Value to check if the do not disturb mode is set by the user. /// </summary> DoNotDisturb } diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs index 7e87c84..110fbe9 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.Notifications { /// <summary> - /// Class containing common properties and methods of Notifications + /// The class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -27,7 +27,7 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// Class for generating Indicator style notification + /// Class for generating indicator style notification. /// </summary> public sealed class IndicatorStyle : StyleBase { @@ -38,12 +38,12 @@ namespace Tizen.Applications.Notifications public string IconPath { get; set; } /// <summary> - /// Gets or sets a sub text for displaying Indicator style + /// Gets or sets a sub text for displaying indicator style. /// </summary> public string SubText { get; set; } /// <summary> - /// Gets the key of IndicatorStyle + /// Gets the key of IndicatorStyle. /// </summary> internal override string Key { diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs index 78029a7..12fcd6a 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.Notifications { /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -27,22 +27,22 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// Class for generating Lock style notification + /// Class for generating lock style notification. /// </summary> public sealed class LockStyle : StyleBase { /// <summary> - /// Gets or sets an absolute path for an image file to display on the icon of Lock style + /// Gets or sets an absolute path for an image file to display the icon of lock style. /// </summary> public string IconPath { get; set; } /// <summary> - /// Gets or sets an absolute path for a thumbnail image file to display on Lock style + /// Gets or sets an absolute path for a thumbnail image file to display on lock style. /// </summary> public string ThumbnailPath { get; set; } /// <summary> - /// Gets the key of LockStyle + /// Gets the key of LockStyle. /// </summary> internal override string Key { diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs index 859a81f..5b450b7 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs @@ -19,7 +19,7 @@ namespace Tizen.Applications.Notifications using System.ComponentModel; /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -29,7 +29,7 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// An object that help notification make to SafeHandle. + /// An object that helps notification to make to SafeHandle. /// </summary> [EditorBrowsable(EditorBrowsableState.Never)] public abstract class MakerBase diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs index bf80eab..84758f2 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs @@ -20,16 +20,16 @@ namespace Tizen.Applications.Notifications using System.ComponentModel; /// <summary> - /// NotificationManager class to post, update, delete and get Notification. + /// NotificationManager class to post, update, delete, and get notification. /// </summary> public static class NotificationManager { /// <summary> - /// Posts a new Notification. + /// Posts a new notification. /// </summary> - /// <param name="notification">Notification to post</param> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="notification">Notification to post.</param> + /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <example> /// <code> @@ -75,11 +75,11 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Updates a posted Notification. + /// Updates a posted notification. /// </summary> - /// <param name="notification">Notification to update</param> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="notification">Notification to update.</param> + /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <example> /// <code> @@ -130,7 +130,7 @@ namespace Tizen.Applications.Notifications /// </example> /// <privilege>http://tizen.org/privilege/notification</privilege> /// <pre> - /// Post method should be called on the Notification object. + /// Post method should be called on the notification object. /// </pre> public static void Update(Notification notification) { @@ -148,11 +148,11 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Deletes a posted Notification. + /// Deletes a posted notification. /// </summary> - /// <param name="notification">Notification to remove</param> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <param name="notification">Notification to remove.</param> + /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <example> /// <code> @@ -172,7 +172,7 @@ namespace Tizen.Applications.Notifications /// </example> /// <privilege>http://tizen.org/privilege/notification</privilege> /// <pre> - /// Post method should be called on the Notification object. + /// Post method should be called on the notification object. /// </pre> public static void Delete(Notification notification) { @@ -189,9 +189,9 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Removes all posted Notification of calling application. + /// Removes all posted notifications of calling application. /// </summary> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <example> /// <code> @@ -237,12 +237,12 @@ namespace Tizen.Applications.Notifications /// 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 NotificationManager.Post method. + /// 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="ArgumentException">Throwing the same exception when argument is invalid and when the tag does not exist is misleading</exception> + /// <param name="tag">Tag used to query.</param> + /// <returns>Notification Object with specified tag.</returns> + /// <exception cref="ArgumentException">Throwing the same exception when argument is invalid and when the tag does not exist is misleading.</exception> /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <example> @@ -296,13 +296,13 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Saves a notification template to the notification database + /// 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="ArgumentException">Thrown when argument is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> - /// <exception cref="InvalidOperationException">Thrown when can't save as template</exception> + /// <param name="notification">Notification to save as template.</param> + /// <param name="name">Template name.</param> + /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission is denied.</exception> + /// <exception cref="InvalidOperationException">Thrown when it can't be saved as a template.</exception> /// <example> /// <code> /// Notification notification = new Notification @@ -352,11 +352,11 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Loads a notification template from the notification database + /// 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="ArgumentException">Throwing the same exception when argument is invalid and when the template does not exist is misleading</exception> + /// <param name="name">Template name.</param> + /// <returns>Notification Object with inputted template name.</returns> + /// <exception cref="ArgumentException">Throwing the same exception when argument is invalid and when the template does not exist is misleading.</exception> /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <example> @@ -429,11 +429,11 @@ namespace Tizen.Applications.Notifications /// <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. + /// 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 state if notification is posted</returns> - /// <exception cref="UnauthorizedAccessException">Thrown in case of permission denied.</exception> + /// <returns>NotificationBlockState is a state if notification is posted.</returns> + /// <exception cref="UnauthorizedAccessException">Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static NotificationBlockState GetBlockState() diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs index 3630755..a124d42 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.Notifications { /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -27,8 +27,8 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// Class for displaying progress notification - /// You must initialize progress category, current, max value when you create object. + /// Class for displaying progress notification. + /// You must initialize progress category, current, and max value when you create an object. /// </summary> public sealed class ProgressType : MakerBase { @@ -37,12 +37,12 @@ namespace Tizen.Applications.Notifications /// <summary> /// Initializes a new instance of the <see cref="ProgressType"/> class. - /// You must initialize category, current, max value of progress. + /// 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 argument is invalid</exception> + /// <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> public ProgressType(ProgressCategory category, double current, double max) { if (IsNegativeNumber(current)) @@ -67,9 +67,9 @@ namespace Tizen.Applications.Notifications public ProgressCategory Category { get; set; } /// <summary> - /// Gets or sets current value of ProgressType + /// Gets or sets current value of ProgressType. /// </summary> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public double ProgressCurrent { get @@ -89,9 +89,9 @@ namespace Tizen.Applications.Notifications } /// <summary> - /// Gets or sets max value of ProgressType + /// Gets or sets max value of ProgressType. /// </summary> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <exception cref="ArgumentException">Thrown when argument is invalid.</exception> public double ProgressMax { get diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs index 3b828d9..c530d78 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.Notifications { /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -28,19 +28,19 @@ namespace Tizen.Applications.Notifications { /// <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. + /// You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl. /// </summary> public sealed class ReplyAction : MakerBase { /// <summary> - /// Gets or sets the Index of Button which is appeared at Notification. - /// If you set ParentIndex, ReplyAction is displayed when button matched with ParentIndex click by the user. - /// If you don't set ParentIndex, appeared to notification directly. + /// 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> public ButtonIndex ParentIndex { get; set; } = ButtonIndex.None; /// <summary> - /// Gets or sets the PlaceHolderText of ReplyAction which is appeared at Notification. + /// Gets or sets the PlaceHolderText of ReplyAction which appears at notification. /// If you set PlaceHolderText, it is displayed to placeholder in notification. /// </summary> public string PlaceHolderText { get; set; } @@ -55,8 +55,8 @@ namespace Tizen.Applications.Notifications public int ReplyMax { get; set; } = 160; /// <summary> - /// Gets or sets the Button which is appeared to ReplyAction in Notification. - /// You must set a Button. Otherwise user can't send written text to application which is set by AppControl. + /// 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. diff --git a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs index 84ec3a7..a7dda89 100755 --- a/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs +++ b/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.Notifications { /// <summary> - /// Class containing common properties and methods of Notifications + /// This class contains common properties and methods of notifications. /// </summary> /// <remarks> /// A notification is a message that is displayed on the notification area. @@ -27,8 +27,8 @@ namespace Tizen.Applications.Notifications public sealed partial class Notification { /// <summary> - /// An object that 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. + /// 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> public abstract class StyleBase : MakerBase { diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs index 5d05883..0f26d6c 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Applications.NotificationEventListener public class NotificationDeleteEventArgs : EventArgs { /// <summary> - /// Gets the unique number of the Notification. + /// Gets the unique number of the notification. /// </summary> public int UniqueNumber { get; internal set; } } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs index ba2ed0d..140ab96 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs @@ -41,55 +41,55 @@ namespace Tizen.Applications.NotificationEventListener } /// <summary> - /// Gets the unique id of Notification. + /// Gets the unique ID of the notification. /// </summary> public int UniqueNumber { get; internal set; } /// <summary> - /// Gets the appId of Notification. + /// Gets the appId of the notification. /// </summary> public string AppID { get; internal set; } /// <summary> - /// Gets the title of Notification. + /// Gets the title of the notification. /// </summary> public string Title { get; internal set; } /// <summary> - /// Gets the content text of Notification. + /// Gets the content text of the notification. /// </summary> public string Content { get; internal set; } /// <summary> - /// Gets the icon's path of Notification. + /// Gets the icon's path of the notification. /// </summary> public string Icon { get; internal set; } /// <summary> - /// Gets the sub icon path of Notification. + /// Gets the sub icon path of the notification. /// </summary> public string SubIcon { get; internal set; } /// <summary> - /// Gets the Timestamp of notification is visible or not. + /// Gets the timestamp if the notification is visible or not. /// </summary> public bool IsTimeStampVisible { get; internal set; } /// <summary> - /// Gets TimeStamp of Notification. + /// Gets TimeStamp of notification. /// </summary> /// <remarks> - /// If IsTimeStampVisible property is set false, this TimeStamp property is meanless. + /// If IsTimeStampVisible property is set false, this TimeStamp property is meaningless. /// </remarks> public DateTime TimeStamp { get; internal set; } /// <summary> - /// Gets the count which is displayed at the right side of notification. + /// Gets the count, which is displayed at the right side of notification. /// </summary> public int Count { get; internal set; } /// <summary> - /// Gets the Tag of notification. + /// Gets the tag of notification. /// </summary> public string Tag { get; internal set; } @@ -98,7 +98,7 @@ namespace Tizen.Applications.NotificationEventListener /// <summary> /// Gets a value that determines whether notification is displayed on the default viewer. - /// If IsDisplay property set false and add style, you can see only style notification. + /// If IsDisplay property is set as false and add style, you can see only style notification. /// </summary> public bool IsVisible { get; internal set; } = true; @@ -106,7 +106,7 @@ namespace Tizen.Applications.NotificationEventListener public bool HasEventFlag { get; internal set; } = false; /// <summary> - /// Gets the AppControl which is invoked when notification is clicked. + /// Gets the AppControl, which is invoked when notification is clicked. /// </summary> public AppControl Action { get; internal set; } @@ -116,7 +116,7 @@ namespace Tizen.Applications.NotificationEventListener public ProgressArgs Progress { get; internal set; } /// <summary> - /// Gets the AccessoryArgs which has option of Sound, Vibration, LED. + /// Gets the AccessoryArgs, which has option of sound, vibration, and LED. /// </summary> public AccessoryArgs Accessory { get; internal set; } @@ -137,11 +137,11 @@ namespace Tizen.Applications.NotificationEventListener public NotificationProperty Property { get; internal set; } /// <summary> - /// Gets the styleArgs of active, lock, indicator, bigpicture. + /// Gets the styleArgs of active, lock, indicator, and bigpicture. /// </summary> - /// <typeparam name="T">Type of notification style to be queried</typeparam> - /// <returns>The NotificationEventListener.StyleArgs object associated with the given style</returns> - /// <exception cref="ArgumentException">Thrown when argument is invalid</exception> + /// <typeparam name="T">Type of notification style to be queried.</typeparam> + /// <returns>The NotificationEventListener.StyleArgs object associated with the given style.</returns> + /// <exception cref="ArgumentException">Thrown when an argument is invalid.</exception> public T GetStyle<T>() where T : StyleArgs, new() { T type = new T(); @@ -163,8 +163,8 @@ namespace Tizen.Applications.NotificationEventListener /// <summary> /// Gets the ExtraDataArgs. /// </summary> - /// <param name="key">The key that specifies which extra data</param> - /// <returns>Returns the bundle for key</returns> + /// <param name="key">The key that specifies which extra data.</param> + /// <returns>Returns the bundle for key.</returns> public Bundle GetExtraData(string key) { Bundle bundle; diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs index b09398c..75c1d97 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs @@ -19,12 +19,12 @@ namespace Tizen.Applications.NotificationEventListener using Tizen.Common; /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to get infomation about Notification accessory. + /// Class to get infomation about notification accessory. /// </summary> public class AccessoryArgs { @@ -44,12 +44,12 @@ namespace Tizen.Applications.NotificationEventListener public bool CanVibrate { get; internal set; } /// <summary> - /// Gets the led option. + /// Gets the LED option. /// </summary> public AccessoryOption LedOption { get; internal set; } /// <summary> - /// Gets led on time period that you would like the LED on the device to blink. as well as the rate. + /// Gets LED on time period that you would like the LED on the device to blink as well as the rate. /// </summary> /// <value> /// Default value of LedOnMilliseconds is 0. @@ -58,7 +58,7 @@ namespace Tizen.Applications.NotificationEventListener public int LedOnMillisecond { get; internal set; } /// <summary> - /// Gets led on time period that you would like the LED on the device to blink. as well as the rate. + /// Gets LED on time period that you would like the LED on the device to blink as well as the rate. /// </summary> /// <value> /// Default value of LedOffMillisecond is 0. @@ -67,7 +67,7 @@ namespace Tizen.Applications.NotificationEventListener public int LedOffMillisecond { get; internal set; } /// <summary> - /// Gets led color that you would like the LED on the device to blink. + /// Gets LED color that you would like the LED on the device to blink. /// </summary> public Color LedColor { get; internal set; } } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs index d3aecc6..1618826 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs @@ -19,12 +19,12 @@ namespace Tizen.Applications.NotificationEventListener using System.Collections.Generic; /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to get infomation about Notification Active style. + /// Class to get infomation about notification active style. /// </summary> public class ActiveStyleArgs : StyleArgs { @@ -42,7 +42,7 @@ namespace Tizen.Applications.NotificationEventListener /// </summary> /// <value> /// 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. + /// the active notification, or the app which posted the active notification removes the active notification. /// </value> public bool IsAutoRemove { get; internal set; } @@ -52,17 +52,17 @@ namespace Tizen.Applications.NotificationEventListener public string BackgroundImage { get; internal set; } /// <summary> - /// Gets the default button to display highlight on the active notification + /// Gets the default button to display highlight on the active notification. /// </summary> public ButtonIndex DefaultButton { get; internal set; } /// <summary> - /// Gets timeout value in second when the notification can be hidden from the viewer. + /// Gets timeout value in seconds when the notification can be hidden from the viewer. /// </summary> public int HideTimeout { get; internal set; } /// <summary> - /// Gets timeout value in second when the notification can be deleted from the viewer. + /// Gets timeout value in seconds when the notification can be deleted from the viewer. /// </summary> public int DeleteTimeout { get; internal set; } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs index 2e39158..bbc5289 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs @@ -17,17 +17,17 @@ namespace Tizen.Applications.NotificationEventListener { /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to get infomation about Notification ButtonAction. + /// Class to get infomation about notification ButtonAction. /// </summary> public class ButtonActionArgs { /// <summary> - /// Gets the Index of the Button which is appeared at Notification. + /// Gets the index of the button, which appears at notification. /// </summary> public ButtonIndex Index { get; internal set; } @@ -37,7 +37,7 @@ namespace Tizen.Applications.NotificationEventListener public string Text { get; internal set; } /// <summary> - /// Gets the image's path that represent the button. + /// Gets the image's path that represents the button. /// </summary> public string ImagePath { get; internal set; } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs index 8adcf93..134479f 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs @@ -20,101 +20,101 @@ namespace Tizen.Applications.NotificationEventListener using System.ComponentModel; /// <summary> - /// Enumeration for Progress category + /// Enumeration for the progress category. /// </summary> public enum ProgressCategory { /// <summary> - /// Value for percent type + /// Value for the percent type. /// </summary> Percent, /// <summary> - /// Value for time type + /// Value for the time type. /// </summary> Time, /// <summary> - /// Value for pending type which is not updated progress current value + /// Value for the pending type, which is not the updated progress current value. /// </summary> PendingBar } /// <summary> - /// Enumeration for Accessory option + /// Enumeration for the accessory option. /// </summary> public enum AccessoryOption { /// <summary> - /// Value for off accessory option + /// Value for off accessory option. /// </summary> Off = -1, /// <summary> - /// Value for on accessory option + /// Value for on accessory option. /// </summary> On, /// <summary> - /// Value for custom accessory option + /// Value for the custom accessory option. /// </summary> Custom } /// <summary> - /// Enumeration for Button Index + /// Enumeration for the button index. /// </summary> public enum ButtonIndex { /// <summary> - /// Value for default button index + /// Value for the default button index. /// </summary> None = -1, /// <summary> - /// Value for first button index + /// Value for the first button index. /// </summary> First, /// <summary> - /// Value for second button index + /// Value for the second button index. /// </summary> Second, /// <summary> - /// Value for third button index + /// Value for the third button index. /// </summary> Third } /// <summary> - /// Enumeration for notification particular property + /// Enumeration for the notification particular property. /// </summary> [Flags] public enum NotificationProperty { /// <summary> - /// Value for adjust nothing + /// Value for the adjust nothing. /// </summary> None = 0x00, /// <summary> - /// Value for display only SIM card inserted + /// Value for display only when SIM card inserted. /// </summary> DisplayOnlySimMode = 0x01, /// <summary> - /// Value for disable application launch when it selected + /// Value for disable application launch when it is selected. /// </summary> DisableAppLaunch = 0x02, /// <summary> - /// Value for disable auto delete when it selected + /// Value for disable auto delete when it is selected. /// </summary> DisableAutoDelete = 0x04, /// <summary> - /// Value for deleted when device is rebooted even though notification is not set OngoingType + /// Value for deleted when device is rebooted even though notification is not set OngoingType. /// </summary> VolatileDisplay = 0x100, } @@ -126,47 +126,47 @@ namespace Tizen.Applications.NotificationEventListener public enum UserEventType { /// <summary> - /// Event type : Click on button 1 + /// Event type : Click on button 1. /// </summary> ClickOnButton1 = 0, /// <summary> - /// Event type : Click on button 2 + /// Event type : Click on button 2. /// </summary> ClickOnButton2, /// <summary> - /// Event type : Click on button 3 + /// Event type : Click on button 3. /// </summary> ClickOnButton3, /// <summary> - /// Event type : Click on text_input button + /// Event type : Click on text_input button. /// </summary> ClickOnReplyButton = 8, /// <summary> - /// Event type : Hidden by user + /// Event type : Hidden by user. /// </summary> HiddenByUser = 100, /// <summary> - /// Event type : Deleted by timer + /// Event type : Deleted by timer. /// </summary> HiddenByTimeout = 101, /// <summary> - /// Event type : Deleted by timer + /// Event type : Deleted by timer. /// </summary> HiddenByExternal = 102, /// <summary> - /// Event type : Clicked by user + /// Event type : Clicked by user. /// </summary> ClickOnNotification = 200, /// <summary> - /// Event type : Deleted by user + /// Event type : Deleted by user. /// </summary> DeleteNotification = 201, } @@ -177,12 +177,12 @@ namespace Tizen.Applications.NotificationEventListener internal enum NotificationType { /// <summary> - /// Notification type + /// Notification type. /// </summary> Notification = 0, /// <summary> - /// Ongoing type + /// Ongoing type. /// </summary> Ongoing, } @@ -193,123 +193,123 @@ namespace Tizen.Applications.NotificationEventListener internal enum NotificationText { /// <summary> - /// Title + /// Title. /// </summary> Title = 0, /// <summary> - /// Content + /// Content. /// </summary> Content, /// <summary> - /// Text to display event count + /// Text to display the event count. /// </summary> EventCount = 3, /// <summary> - /// Box contents 1 + /// Box contents 1. /// </summary> FirstMainText, /// <summary> - /// Box contents 1-1 + /// Box contents 1-1. /// </summary> FirstSubText, /// <summary> - /// Box contents 2 + /// Box contents 2. /// </summary> SecondMainText, /// <summary> - /// Box contents 2-1 + /// Box contents 2-1. /// </summary> SecondSubText, /// <summary> - /// Text on button 1 + /// Text on button 1. /// </summary> FirstButton = 13, /// <summary> - /// Text on button 2 + /// Text on button 2. /// </summary> SecondButton, /// <summary> - /// Text on button 3 + /// Text on button 3. /// </summary> ThirdButton, /// <summary> - /// Guide text on the message reply box + /// Guide text on the message reply box. /// </summary> PlaceHolder = 19, /// <summary> - /// Text on button the on message reply box + /// Text on button on the message reply box. /// </summary> InputButton = 20, } /// <summary> - /// Enumeration for image type. + /// Enumeration for the image type. /// </summary> internal enum NotificationImage { /// <summary> - /// Icon + /// Icon. /// </summary> Icon = 0, /// <summary> - /// Indicator icon + /// Indicator icon. /// </summary> Indicator, /// <summary> - /// Lock screen icon + /// Lock screen icon. /// </summary> Lockscreen, /// <summary> - /// Thumbnail + /// Thumbnail. /// </summary> Thumbnail, /// <summary> - /// Lock screen thumbnail + /// Lock screen thumbnail. /// </summary> ThumbnailLockscreen, /// <summary> - /// Icon + /// Icon. /// </summary> SubIcon, /// <summary> - /// image displayed on background + /// Image displayed on background. /// </summary> Background, /// <summary> - /// Image for button 1 + /// Image for button 1. /// </summary> Button_1 = 12, /// <summary> - /// Image for button 2 + /// Image for button 2. /// </summary> Button_2, /// <summary> - /// Image for button 3 + /// Image for button 3. /// </summary> Button_3, /// <summary> - /// Image for message reply + /// Image for message reply. /// </summary> TextInputButton = 18, } @@ -320,27 +320,27 @@ namespace Tizen.Applications.NotificationEventListener internal enum NotificationLayout { /// <summary> - /// Default + /// Default. /// </summary> None = 0, /// <summary> - /// Layout for notification. Used to inform single event + /// Layout for notification. Used to inform single event. /// </summary> SingleEvent = 1, /// <summary> - /// Layout for notification. Used to display images + /// Layout for notification. Used to display images. /// </summary> Thumbnail = 3, /// <summary> - /// Layout for ongoing notification. Used to display text message + /// Layout for ongoing notification. Used to display text message. /// </summary> OngoingEvent = 4, /// <summary> - /// Layout for ongoing notification. Used to display progress + /// Layout for ongoing notification. Used to display progress. /// </summary> OngoingProgress = 5, } @@ -351,7 +351,7 @@ namespace Tizen.Applications.NotificationEventListener internal enum LaunchOption { /// <summary> - /// Launching with app control + /// Launching with application control. /// </summary> AppControl = 1 } @@ -362,32 +362,32 @@ namespace Tizen.Applications.NotificationEventListener internal enum NotificationOperationDataType { /// <summary> - /// Default + /// Default. /// </summary> Min = 0, /// <summary> - /// Operation type + /// Operation type. /// </summary> Type, /// <summary> - /// Private ID + /// Private ID. /// </summary> UniqueNumber, /// <summary> - /// Notification handler + /// Notification handler. /// </summary> Notification, /// <summary> - /// Reserved + /// Reserved. /// </summary> ExtraInformation1, /// <summary> - /// Reserved + /// Reserved. /// </summary> ExtraInformation2, } @@ -398,22 +398,22 @@ namespace Tizen.Applications.NotificationEventListener internal enum NotificationOperationType { /// <summary> - /// Default + /// Default. /// </summary> None = 0, /// <summary> - /// Notification inserted + /// Notification inserted. /// </summary> Insert, /// <summary> - /// Notification updated + /// Notification updated. /// </summary> Update, /// <summary> - /// Notification deleted + /// Notification deleted. /// </summary> Delete, } @@ -424,32 +424,32 @@ namespace Tizen.Applications.NotificationEventListener internal enum ClickEventType { /// <summary> - /// Event type : Click on button 1 + /// Event type : Click on button 1. /// </summary> FirstButton = 0, /// <summary> - /// Event type : Click on button 2 + /// Event type : Click on button 2. /// </summary> SecondButton = 1, /// <summary> - /// Event type : Click on button 3 + /// Event type : Click on button 3. /// </summary> ThirdButton = 2, /// <summary> - /// Event type : Click on icon + /// Event type : Click on icon. /// </summary> Icon = 6, /// <summary> - /// Event type : Click on thumbnail + /// Event type : Click on thumbnail. /// </summary> Thumbnail = 7, /// <summary> - /// Event type : Click on text_input button + /// Event type : Click on text_input button. /// </summary> InputButton = 8, } @@ -461,32 +461,32 @@ namespace Tizen.Applications.NotificationEventListener internal enum NotificationDisplayApplist { /// <summary> - /// Notification Tray(Quickpanel) + /// Notification Tray(Quickpanel). /// </summary> Tray = 0x00000001, /// <summary> - /// Ticker notification + /// Ticker notification. /// </summary> Ticker = 0x00000002, /// <summary> - /// Lock screen + /// Lock screen. /// </summary> Lock = 0x00000004, /// <summary> - /// Indicator + /// Indicator. /// </summary> Indicator = 0x00000008, /// <summary> - /// Active notification + /// Active notification. /// </summary> Active = 0x00000010, /// <summary> - /// All display application except active notification + /// All display application except active notification. /// </summary> All = 0x0000000f, } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs index bc04cf1..32ad1f5 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs @@ -17,22 +17,22 @@ namespace Tizen.Applications.NotificationEventListener { /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to generate the Indicator style notification. + /// Class to generate the indicator style notification. /// </summary> public class IndicatorStyleArgs : StyleArgs { /// <summary> - /// Gets the path of the image file to display on the icon of Indicator style. + /// Gets the path of the image file to display on the icon of indicator style. /// </summary> public string IconPath { get; internal set; } /// <summary> - /// Gets the sub text to display Indicator style. + /// Gets the sub text to display indicator style. /// </summary> public string SubText { get; internal set; } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs index 62ca496..3a24f18 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs @@ -17,22 +17,22 @@ namespace Tizen.Applications.NotificationEventListener { /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to get infomation about Notification Lock style. + /// 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. + /// Gets the path of the image file to display on the icon of lock style. /// </summary> public string IconPath { get; internal set; } /// <summary> - /// Gets the path of the thumbnail image file to display on the icon of Lock style. + /// Gets the path of the thumbnail image file to display on the icon of lock style. /// </summary> public string Thumbnail { get; internal set; } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs index ed01380..069d4e8 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs @@ -17,12 +17,12 @@ namespace Tizen.Applications.NotificationEventListener { /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to get infomation about Progress Notification. + /// Class to get infomation about progress notification. /// </summary> public class ProgressArgs { diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs index d96ebf0..426f496 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs @@ -17,23 +17,23 @@ namespace Tizen.Applications.NotificationEventListener { /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { /// <summary> - /// Class to get infomation about Notification ReplyAction. + /// Class to get infomation about notification ReplyAction. /// </summary> public class ReplyActionArgs { /// <summary> - /// Gets Index of Button which is appeared at Notification. + /// Gets index of button, which appears at notification. /// If there is no ParentIndex, the ReplyAction should be displayed directly on the active notification. /// </summary> public ButtonIndex ParentIndex { get; internal set; } = ButtonIndex.None; /// <summary> - /// Gets the PlaceHolderText of ReplyAction which is appeared at Notification. + /// Gets the PlaceHolderText of ReplyAction, which appears at notification. /// It will be displayed to the text input box on the active notification. /// </summary> public string PlaceHolderText { get; internal set; } diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs index 5ba07c7..69af7d2 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications.NotificationEventListener { /// <summary> - /// This class provides the methods and properties to get information about the posted or updated notification. + /// This class provides methods and properties to get information about the posted or updated notification. /// </summary> public partial class NotificationEventArgs { diff --git a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs index b1baf13..4d6f582 100755 --- a/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs +++ b/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs @@ -25,7 +25,7 @@ namespace Tizen.Applications.NotificationEventListener /// 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. + /// The event listener can use this class to get a list of notifications or to clear notifications. /// </remarks> public partial class NotificationListenerManager { @@ -63,8 +63,8 @@ namespace Tizen.Applications.NotificationEventListener /// <summary> /// Event handler for notification insert event. /// </summary> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException"> Thrown in case of Permission deny.</exception> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static event EventHandler<NotificationEventArgs> Added @@ -109,8 +109,8 @@ namespace Tizen.Applications.NotificationEventListener /// <summary> /// Event handler for notification update event. /// </summary> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException"> Thrown in case of Permission deny.</exception> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static event EventHandler<NotificationEventArgs> Updated @@ -155,8 +155,8 @@ namespace Tizen.Applications.NotificationEventListener /// <summary> /// Event handler for notification delete event. /// </summary> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException"> Thrown in case of Permission deny.</exception> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static event EventHandler<NotificationDeleteEventArgs> Deleted @@ -286,12 +286,12 @@ namespace Tizen.Applications.NotificationEventListener } /// <summary> - /// Deletes a Notification with appId and uniqueNumber. + /// Deletes a notification with appId and uniqueNumber. /// </summary> /// <param name="appId">The name of the application you want to delete.</param> /// <param name="uniqueNumber">The unique number of the notification.</param> - /// <exception cref="ArgumentException">Thrown in case of Invalid parameter.</exception> - /// <exception cref="UnauthorizedAccessException"> Thrown in case of Permission deny.</exception> + /// <exception cref="ArgumentException">Thrown in case of an invalid parameter.</exception> + /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static void Delete(string appId, int uniqueNumber) @@ -311,9 +311,9 @@ namespace Tizen.Applications.NotificationEventListener } /// <summary> - /// Deletes all Notification. + /// Deletes all notifications. /// </summary> - /// <exception cref="UnauthorizedAccessException"> Thrown in case of Permission deny.</exception> + /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static void DeleteAll() @@ -336,7 +336,7 @@ namespace Tizen.Applications.NotificationEventListener /// <summary> /// Returns the notification list. /// </summary> - /// <exception cref="UnauthorizedAccessException"> Thrown in case of Permission deny.</exception> + /// <exception cref="UnauthorizedAccessException"> Thrown in case of a permission is denied.</exception> /// <exception cref="InvalidOperationException">Thrown in case of any internal error.</exception> /// <privilege>http://tizen.org/privilege/notification</privilege> public static IList<NotificationEventArgs> GetList() diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs b/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs index cd1512b..a702091 100644 --- a/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// Enumeration for certificate compare result type. + /// Enumeration for the certificate compare result type. /// </summary> public enum CertCompareResultType { @@ -32,15 +32,15 @@ namespace Tizen.Applications /// </summary> Mismatch = Interop.PackageManager.CertCompareResultType.Mismatch, /// <summary> - /// First package doesn't have certificate. + /// First package does not have the certificate. /// </summary> LhsNoCert = Interop.PackageManager.CertCompareResultType.LhsNoCert, /// <summary> - /// Second package doesn't have certificate. + /// Second package does not have the certificate. /// </summary> RhsNoCert = Interop.PackageManager.CertCompareResultType.RhsNoCert, /// <summary> - /// Certificates of both packages are not exist. + /// Certificates for both the packages do not exist. /// </summary> BothNoCert = Interop.PackageManager.CertCompareResultType.BothNoCert } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs b/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs index b9d5858..912fca1 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs @@ -17,20 +17,20 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for certification type. + /// Enumeration for the certification types. /// </summary> public enum CertificateType { /// <summary> - /// Author Certificate. + /// Author certificate. /// </summary> Author, /// <summary> - /// Distributor Certificate. + /// Distributor certificate. /// </summary> Distributor, /// <summary> - /// Distributor2 Certificate. + /// Distributor2 certificate. /// </summary> Distributor2, } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs b/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs index 3dcd619..df075df 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs @@ -22,7 +22,7 @@ using System.Threading.Tasks; namespace Tizen.Applications { /// <summary> - /// This class provide methods and properties to get information about packages. + /// This class provides the methods and properties to get information about the packages. /// </summary> public class Package { @@ -50,7 +50,7 @@ namespace Tizen.Applications } /// <summary> - /// Package ID. + /// The package ID. /// </summary> public string Id { get { return _id; } } @@ -92,7 +92,7 @@ namespace Tizen.Applications public string TizenExpansionPackageName { get { return _expansionPackageName; } } /// <summary> - /// Checks whether the package is system package. + /// Checks whether the package is a system package. /// </summary> public bool IsSystemPackage { get { return _isSystemPackage; } } @@ -112,12 +112,12 @@ namespace Tizen.Applications public bool IsAccessible { get { return _isAccessible; } } /// <summary> - /// Certificate information for the package + /// Certificate information for the package. /// </summary> public IReadOnlyDictionary<CertificateType, PackageCertificate> Certificates { get { return _certificates; } } /// <summary> - /// Requested privilege for the package + /// Requested privilege for the package. /// </summary> public IEnumerable<string> Privileges { get { return _privileges; } } @@ -127,19 +127,19 @@ namespace Tizen.Applications public int InstalledTime { get { return _installedTime; } } /// <summary> - /// Retrieves all application IDs of this package. + /// Retrieves all the application IDs of this package. /// </summary> - /// <returns>Returns a dictionary containing all application info for given application type.</returns> + /// <returns>Returns a dictionary containing all the application information for a given application type.</returns> public IEnumerable<ApplicationInfo> GetApplications() { return GetApplications(ApplicationType.All); } /// <summary> - /// Retrieves all application IDs of this package. + /// Retrieves all the application IDs of this package. /// </summary> - /// <param name="type">Optional: AppType enum value</param> - /// <returns>Returns a dictionary containing all application info for given application type.</returns> + /// <param name="type">Optional: AppType enumeration value.</param> + /// <returns>Returns a dictionary containing all the application information for a given application type.</returns> public IEnumerable<ApplicationInfo> GetApplications(ApplicationType type) { List<ApplicationInfo> appInfoList = new List<ApplicationInfo>(); @@ -171,9 +171,9 @@ namespace Tizen.Applications } /// <summary> - /// Gets size information for this package. + /// Gets the package size information. /// </summary> - /// <returns>package size information</returns> + /// <returns>Package size information.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> public async Task<PackageSizeInformation> GetSizeInformationAsync() { @@ -196,12 +196,12 @@ namespace Tizen.Applications } /// <summary> - /// Compare certificate information with given package id. + /// Compares the certificate information with the given package ID. /// </summary> - /// <param name="packageId">Id of the package</param> - /// <returns>Certificate comparison result</returns> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> + /// <param name="packageId">ID of the package.</param> + /// <returns>Certificate comparison result.</returns> + /// <exception cref="ArgumentException">Thrown when a failed input package ID is invalid.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> public CertCompareResultType CompareCertInfo(string packageId) { Interop.PackageManager.CertCompareResultType compareResult; diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs index 914d21a..2e9a979 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs @@ -21,7 +21,7 @@ using System.Runtime.InteropServices; namespace Tizen.Applications { /// <summary> - /// This class provides information about package certification. + /// This class provides information about the package certification. /// </summary> public class PackageCertificate { @@ -39,17 +39,17 @@ namespace Tizen.Applications } /// <summary> - /// Root certificate + /// Root certificate. /// </summary> public string Root { get { return _root; } } /// <summary> - /// Intermediate certificate + /// Intermediate certificate. /// </summary> public string Intermediate { get { return _intermediate; } } /// <summary> - /// Signer certificate + /// Signer certificate. /// </summary> public string Signer { get { return _signer; } } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs index cb45bbb..bfc959c 100644 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs @@ -22,7 +22,7 @@ using System.Threading.Tasks; namespace Tizen.Applications { /// <summary> - /// This class provide methods and properties for DRM operation + /// This class provides the methods and properties for the DRM operation. /// </summary> public class PackageDrm { @@ -37,21 +37,21 @@ namespace Tizen.Applications } /// <summary> - /// Returns response data + /// Returns the response data. /// </summary> - /// <returns>Returns response data which is given when GenerateLicenseRequest has invoked</returns> + /// <returns>Returns the response data which is given when GenerateLicenseRequest has been invoked.</returns> public string ResponseData { get { return _responseData; } } /// <summary> - /// Returns request data + /// Returns the request data. /// </summary> - /// <returns>Returns request data which is generated when GenerateLicenseRequest has invoked</returns> + /// <returns>Returns the request data which is generated when GenerateLicenseRequest has been invoked.</returns> public string RequestData { get { return _requestData; } } /// <summary> - /// Returns license URL + /// Returns the license URL. /// </summary> - /// <returns>Returns license URL which is generated when GenerateLicenseRequest has invoked</returns> + /// <returns>Returns the license URL which is generated when GenerateLicenseRequest has been invoked.</returns> public string LicenseUrl { get { return _licenseUrl; } } internal static PackageDrm CreateDrmRequest(string responseData, string requestData, string licenseUrl) diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs index 827a87f..e8bcbb7 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs @@ -17,12 +17,12 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for package manager event state. + /// Enumeration for the package manager event state. /// </summary> public enum PackageEventState { /// <summary> - /// Processing started + /// Processing started. /// </summary> Started = Interop.PackageManager.PackageEventState.Started, /// <summary> @@ -30,11 +30,11 @@ namespace Tizen.Applications /// </summary> Processing = Interop.PackageManager.PackageEventState.Processing, /// <summary> - /// Processing Completed. + /// Processing completed. /// </summary> Completed = Interop.PackageManager.PackageEventState.Completed, /// <summary> - /// Processing Failed. + /// Processing failed. /// </summary> Failed = Interop.PackageManager.PackageEventState.Failed } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs index 15d1f1b..5b9ea4e 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for package manager event type. + /// Enumeration for the package manager event types. /// </summary> public enum PackageEventType { diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs index 8ebff43..b20f495 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs @@ -19,14 +19,14 @@ using System.Collections.Generic; namespace Tizen.Applications { /// <summary> - /// This class is a parameter of PackageManager::GetPackages method. + /// This class is a parameter of the PackageManager::GetPackages method. /// </summary> public class PackageFilter { private IDictionary<string, bool> _filter; /// <summary> - /// Default constructor with empty filter list. All installed applications will satisfy this filter unless updated with more specific filters. + /// The default constructor with an empty filter list. All the installed applications will satisfy this filter unless updated with more specific filters. /// </summary> public PackageFilter() { @@ -34,7 +34,7 @@ namespace Tizen.Applications } /// <summary> - /// Constructor with specific filters. Using this will filter out installed packages which do not meet the criteria of the filters. + /// The constructor with specific filters. Using this will filter out the installed packages which do not meet the filter criteria. /// </summary> public PackageFilter(IDictionary<string, bool> filter) { @@ -53,28 +53,28 @@ namespace Tizen.Applications } /// <summary> - /// This class contains possible keys for filter to be used in the GetPackages method. + /// This class contains possible keys for the filter to be used in the GetPackages method. /// </summary> public static class Keys { /// <summary> - /// Key of the boolean property for filtering whether the package is removable + /// Key of the boolean property for filtering if the package is removable. /// </summary> public const string Removable = "PMINFO_PKGINFO_PROP_PACKAGE_REMOVABLE"; /// <summary> - /// Key of the boolean property for filtering whether the package is readonly. + /// Key of the boolean property for filtering if the package is read-only. /// </summary> public const string ReadOnly = "PMINFO_PKGINFO_PROP_PACKAGE_READONLY"; /// <summary> - /// Key of the boolean property for filtering whether the package supports disabling. + /// Key of the boolean property for filtering if the package supports disabling. /// </summary> public const string SupportsDisable = "PMINFO_PKGINFO_PROP_PACKAGE_SUPPORT_DISABLE"; /// <summary> - /// Key of the boolean property for filtering whether the package is disabled. + /// Key of the boolean property for filtering if the package is disabled. /// </summary> public const string Disable = "PMINFO_PKGINFO_PROP_PACKAGE_DISABLE"; /// <summary> - /// Key of the boolean property for filtering whether the package is preloaded. + /// Key of the boolean property for filtering if the package is preloaded. /// </summary> public const string Preload = "PMINFO_PKGINFO_PROP_PACKAGE_PRELOAD"; } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs index b7f37ef..dcabacc 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs @@ -25,7 +25,7 @@ namespace Tizen.Applications /// PackageManager class. This class has the methods and events of the PackageManager. /// </summary> /// <remarks> - /// The package manager is one of the core modules of Tizen application framework, and responsible for getting their information. + /// The package manager is one of the core modules of the Tizen application framework and responsible for getting their information. /// You can also retrieve information related to the packages that are installed on the device. /// </remarks> public static class PackageManager @@ -43,13 +43,13 @@ namespace Tizen.Applications private static Interop.PackageManager.PackageManagerEventCallback s_packageManagerEventCallback; /// <summary> - /// Event Callback Method for the request. + /// Event callback method for the request. /// </summary> - /// <param name="type">Type of the package which was requested</param> - /// <param name="packageId">ID of the package which was requested</param> - /// <param name="eventType">Event type of the request</param> - /// <param name="eventState">Current event state of the request</param> - /// <param name="progress">Progress for the request being processed by the package manager (in percent)</param> + /// <param name="type">Type of the package which was requested.</param> + /// <param name="packageId">ID of the package which was requested.</param> + /// <param name="eventType">Event type of the request.</param> + /// <param name="eventState">Current event state of the request.</param> + /// <param name="progress">Progress for the request being processed by the package manager (in percent).</param> public delegate void RequestEventCallback(string type, string packageId, PackageEventType eventType, PackageEventState eventState, int progress); private static Dictionary<int, RequestEventCallback> RequestCallbacks = new Dictionary<int, RequestEventCallback>(); @@ -59,7 +59,7 @@ namespace Tizen.Applications private delegate Interop.PackageManager.ErrorCode InstallMethod(SafePackageManagerRequestHandle requestHandle, string pkgPath, out int requestID); /// <summary> - /// InstallProgressChanged event. This event is occurred when a package is getting installed and the progress of the request to the package manager changes. + /// InstallProgressChanged event. This event occurs when a package is getting installed and the progress of the request to the package manager is changed. /// </summary> public static event EventHandler<PackageManagerEventArgs> InstallProgressChanged { @@ -78,7 +78,7 @@ namespace Tizen.Applications } /// <summary> - /// UninstallProgressChanged event. This event is occurred when a package is getting uninstalled and the progress of the request to the package manager changes. + /// UninstallProgressChanged event. This event occurs when a package is getting uninstalled and the progress of the request to the package manager is changed. /// </summary> public static event EventHandler<PackageManagerEventArgs> UninstallProgressChanged { @@ -97,7 +97,7 @@ namespace Tizen.Applications } /// <summary> - /// UpdateProgressChanged event. This event is occurred when a package is getting updated and the progress of the request to the package manager changes. + /// UpdateProgressChanged event. This event occurs when a package is getting updated and the progress of the request to the package manager is changed. /// </summary> public static event EventHandler<PackageManagerEventArgs> UpdateProgressChanged { @@ -116,7 +116,7 @@ namespace Tizen.Applications } /// <summary> - /// MoveProgressChanged event. This event is occurred when a package is getting moved and the progress of the request to the package manager changes. + /// MoveProgressChanged event. This event occurs when a package is getting moved and the progress of the request to the package manager is changed. /// </summary> public static event EventHandler<PackageManagerEventArgs> MoveProgressChanged { @@ -135,7 +135,7 @@ namespace Tizen.Applications } /// <summary> - /// ClearDataProgressChanged event. This event is occurred when data directories are cleared in the given package. + /// ClearDataProgressChanged event. This event occurs when data directories are cleared in the given package. /// </summary> public static event EventHandler<PackageManagerEventArgs> ClearDataProgressChanged { @@ -195,12 +195,12 @@ namespace Tizen.Applications }; /// <summary> - /// Gets the package ID for the given app ID. + /// Gets the package ID for the given application ID. /// </summary> - /// <param name="applicationId">The ID of the application</param> - /// <returns>Returns the ID of the package. Empty string if App ID does not exist</returns> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> + /// <param name="applicationId">The ID of the application.</param> + /// <returns>Returns the ID of the package. Empty string if the application ID does not exist.</returns> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> public static string GetPackageIdByApplicationId(string applicationId) { @@ -220,12 +220,12 @@ namespace Tizen.Applications /// <summary> /// Gets the package information for the given package. /// </summary> - /// <param name="packageId">The ID of the package</param> + /// <param name="packageId">The ID of the package.</param> /// <returns>Returns the package information for the given package ID.</returns> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> + /// <exception cref="ArgumentException">Thrown when the failed input package ID is invalid.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method fails due to an internal I/O error.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> public static Package GetPackage(string packageId) { @@ -233,13 +233,13 @@ namespace Tizen.Applications } /// <summary> - /// Clears the application's internal and external cache directory. + /// Clears the application's internal and external cache directories. /// </summary> - /// <param name="packageId">Id of the package</param> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> - /// <exception cref="SystemException">Thrown when method failed due to internal system error</exception> + /// <param name="packageId">ID of the package.</param> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method fails due to an internal I/O error.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> + /// <exception cref="SystemException">Thrown when the method failed due to an internal system error.</exception> /// <privilege>http://tizen.org/privilege/packagemanager.clearcache</privilege> public static void ClearCacheDirectory(string packageId) { @@ -252,12 +252,12 @@ namespace Tizen.Applications } /// <summary> - /// Clears all application's internal and external cache directory. + /// Clears all the application's internal and external cache directories. /// </summary> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> - /// <exception cref="SystemException">Thrown when method failed due to internal system error</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method fails due to an internal IO error.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> + /// <exception cref="SystemException">Thrown when the method failed due to an internal system error.</exception> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> public static void ClearAllCacheDirectory() @@ -271,17 +271,17 @@ namespace Tizen.Applications } /// <summary> - /// Clears the application's internal and external data directories + /// Clears the application's internal and external data directories. /// </summary> /// <remarks> - /// All files under data, shared/data and shared/trusted in the internal storage are removed. - /// And, If external storeage exists, then all files under data and shared/trusted in the external storage are removed. + /// All files under data, shared/data, and shared/trusted in the internal storage are removed. + /// And, if the external storage exists, then all files under data and shared/trusted in the external storage are removed. /// </remarks> - /// <param name="packageId">Id of the package</param> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> - /// <exception cref="SystemException">Thrown when method failed due to internal system error</exception> + /// <param name="packageId">ID of the package.</param> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal IO error.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> + /// <exception cref="SystemException">Thrown when the method failed due to an internal system error.</exception> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> public static void ClearDataDirectory(string packageId) @@ -295,7 +295,7 @@ namespace Tizen.Applications } /// <summary> - /// Retrieves package information of all installed packages. + /// Retrieves the package information of all installed packages. /// </summary> /// <returns>Returns the list of packages.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> @@ -305,9 +305,9 @@ namespace Tizen.Applications } /// <summary> - /// Retrieves package information of all installed packages satisfying filter conditions. + /// Retrieves the package information of all the installed packages satisfying the filter conditions. /// </summary> - /// <param name="filter">Optional - package filters</param> + /// <param name="filter">Optional - package filters.</param> /// <returns>Returns the list of packages.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> public static IEnumerable<Package> GetPackages(PackageFilter filter) @@ -383,13 +383,13 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <returns>Returns true if installtion request is successful, false otherwise.</returns> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <returns>Returns true if the installation request is successful, otherwise false.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event. + /// The 'true' means that the request for installation is successful. + /// To check the result of the installation, the caller should check the progress using the InstallProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -399,15 +399,15 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="eventCallback">The event callback will be invoked only for the current request</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="eventCallback">The event callback will be invoked only for the current request.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event OR eventCallback. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -417,15 +417,15 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="type">Package type for the package to be installed</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="type">Package type for the package to be installed.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -435,15 +435,15 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -453,16 +453,16 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="type">Package type for the package to be installed</param> - /// <param name="eventCallback">The event callback will be invoked only for the current request</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="type">Package type for the package to be installed.</param> + /// <param name="eventCallback">The event callback will be invoked only for the current request.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event OR eventCallback. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -472,16 +472,16 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed</param> - /// <param name="eventCallback">The event callback will be invoked only for the current request</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed.</param> + /// <param name="eventCallback">The event callback will be invoked only for the current request.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event OR eventCallback. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -491,16 +491,16 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed</param> - /// <param name="type">Package type for the package to be installed</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed.</param> + /// <param name="type">Package type for the package to be installed.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -510,17 +510,17 @@ namespace Tizen.Applications } /// <summary> - /// Installs package located at the given path + /// Installs the package located at the given path. /// </summary> - /// <param name="packagePath">Absolute path for the package to be installed</param> - /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed</param> - /// <param name="type">Package type for the package to be installed</param> - /// <param name="eventCallback">The event callback will be invoked only for the current request</param> - /// <param name="installMode">Optional parameter to indicate special installation mode</param> + /// <param name="packagePath">Absolute path for the package to be installed.</param> + /// <param name="expansionPackagePath">Absolute path for the expansion package to be installed.</param> + /// <param name="type">Package type for the package to be installed.</param> + /// <param name="eventCallback">The event callback will be invoked only for the current request.</param> + /// <param name="installMode">Optional parameter to indicate special installation mode.</param> /// <returns>Returns true if installtion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of installation is seccessful. - /// To check the result of installation, the caller should check the progress using InstallProgressChanged event OR eventCallback. + /// The 'true' means that the request for installation is successful. + /// To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -615,13 +615,13 @@ namespace Tizen.Applications } /// <summary> - /// Uninstalls package with the given name. + /// Uninstalls the package with the given name. /// </summary> - /// <param name="packageId">Id of the package to be uninstalled</param> - /// <returns>Returns true if uninstallation request is successful, false otherwise.</returns> + /// <param name="packageId">ID of the package to be uninstalled.</param> + /// <returns>Returns true if the uninstallation request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of uninstallation is seccessful. - /// To check the result of uninstallation, the caller should check the progress using UninstallProgressChanged event. + /// The 'true' means that the request for uninstallation is successful. + /// To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -631,14 +631,14 @@ namespace Tizen.Applications } /// <summary> - /// Uninstalls package with the given name. + /// Uninstalls package with the given names. /// </summary> - /// <param name="packageId">Id of the package to be uninstalled</param> - /// <param name="type">Optional - Package type for the package to be uninstalled</param> - /// <returns>Returns true if uninstalltion request is successful, false otherwise.</returns> + /// <param name="packageId">ID of the package to be uninstalled.</param> + /// <param name="type">Optional - Package type for the package to be uninstalled.</param> + /// <returns>Returns true if the uninstalltion request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of uninstallation is seccessful. - /// To check the result of uninstallation, the caller should check the progress using UninstallProgressChanged event. + /// The 'true' means that the request for uninstallation is successful. + /// To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -648,14 +648,14 @@ namespace Tizen.Applications } /// <summary> - /// Uninstalls package with the given name. + /// Uninstalls the package with the given name. /// </summary> - /// <param name="packageId">Id of the package to be uninstalled</param> - /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request</param> - /// <returns>Returns true if uninstalltion request is successful, false otherwise.</returns> + /// <param name="packageId">ID of the package to be uninstalled.</param> + /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request.</param> + /// <returns>Returns true if the uninstallation request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of uninstallation is seccessful. - /// To check the result of uninstallation, the caller should check the progress using UninstallProgressChanged event OR eventCallback. + /// The 'true' means that the request for uninstallation is successful. + /// To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event or eventCallback. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -665,15 +665,15 @@ namespace Tizen.Applications } /// <summary> - /// Uninstalls package with the given name. + /// Uninstalls the package with the given name. /// </summary> - /// <param name="packageId">Id of the package to be uninstalled</param> - /// <param name="type">Optional - Package type for the package to be uninstalled</param> - /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request</param> - /// <returns>Returns true if uninstalltion request is successful, false otherwise.</returns> + /// <param name="packageId">ID of the package to be uninstalled</param> + /// <param name="type">Optional - Package type for the package to be uninstalled.</param> + /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request.</param> + /// <returns>Returns true if the uninstallation request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of uninstallation is seccessful. - /// To check the result of uninstallation, the caller should check the progress using UninstallProgressChanged event OR eventCallback. + /// The 'true' means that the request for uninstallation is successful. + /// To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event or eventCallback. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -736,14 +736,14 @@ namespace Tizen.Applications } /// <summary> - /// Move package to given storage. + /// Moves the package to the given storage. /// </summary> - /// <param name="packageId">Id of the package to be moved</param> - /// <param name="newStorage">Storage, package should be moved to</param> - /// <returns>Returns true if move request is successful, false otherwise.</returns> + /// <param name="packageId">ID of the package to be moved.</param> + /// <param name="newStorage">Storage package should be moved to.</param> + /// <returns>Returns true if the move request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of move is seccessful. - /// To check the result of move, the caller should check the progress using MoveProgressChanged event. + /// The 'true' means that the request for move is successful. + /// To check the result of move, the caller should check the progress using the MoveProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -753,15 +753,15 @@ namespace Tizen.Applications } /// <summary> - /// Move package to given storage. + /// Moves the package to the given storage. /// </summary> - /// <param name="packageId">Id of the package to be moved</param> - /// <param name="type">Optional - Package type for the package to be moved</param> - /// <param name="newStorage">Storage, package should be moved to</param> - /// <returns>Returns true if move request is successful, false otherwise.</returns> + /// <param name="packageId">ID of the package to be moved.</param> + /// <param name="type">Optional - Package type for the package to be moved.</param> + /// <param name="newStorage">Storage package should be moved to.</param> + /// <returns>Returns true if the move request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of move is seccessful. - /// To check the result of move, the caller should check the progress using MoveProgressChanged event. + /// The 'true' means that the request for move is successful. + /// To check the result of move, the caller should check the progress using the MoveProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -771,15 +771,15 @@ namespace Tizen.Applications } /// <summary> - /// Move package to given storage. + /// Moves the package to the given storage. /// </summary> - /// <param name="packageId">Id of the package to be moved</param> - /// <param name="newStorage">Storage, package should be moved to</param> - /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request</param> + /// <param name="packageId">ID of the package to be moved.</param> + /// <param name="newStorage">Storage package should be moved to.</param> + /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request.</param> /// <returns>Returns true if move request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of move is seccessful. - /// To check the result of move, the caller should check the progress using MoveProgressChanged event. + /// The 'true' means that the request for move is successful. + /// To check the result of move, the caller should check the progress using the MoveProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -789,16 +789,16 @@ namespace Tizen.Applications } /// <summary> - /// Move package to given storage. + /// Moves the package to the given storage. /// </summary> - /// <param name="packageId">Id of the package to be moved</param> - /// <param name="type">Optional - Package type for the package to be moved</param> - /// <param name="newStorage">Storage, package should be moved to</param> - /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request</param> + /// <param name="packageId">ID of the package to be moved.</param> + /// <param name="type">Optional - Package type for the package to be moved.</param> + /// <param name="newStorage">Storage, package should be moved to.</param> + /// <param name="eventCallback">Optional - The event callback will be invoked only for the current request.</param> /// <returns>Returns true if move request is successful, false otherwise.</returns> /// <remarks> - /// The 'true' means that just the request of move is seccessful. - /// To check the result of move, the caller should check the progress using MoveProgressChanged event. + /// The 'true' means that the request for move is successful. + /// To check the result of move, the caller should check the progress using the MoveProgressChanged event. /// </remarks> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> @@ -862,13 +862,13 @@ namespace Tizen.Applications } /// <summary> - /// Gets permission type of package which has given application id + /// Gets the permission type of the package which has a given application ID. /// </summary> - /// <param name="applicationId">Id of the application</param> - /// <returns>Returns permission type.</returns> + /// <param name="applicationId">ID of the application.</param> + /// <returns>Returns the permission type.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> + /// <exception cref="ArgumentException">Thrown when the failed input package ID is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> public static PermissionType GetPermissionTypeByApplicationId(string applicationId) { Interop.PackageManager.PackageManagerPermissionType permissionType; @@ -882,13 +882,13 @@ namespace Tizen.Applications } /// <summary> - /// Gets package's preload attribute which contain given applicion id + /// Gets the package's preload attribute which contains a given application ID. /// </summary> - /// <param name="applicationId">Id of the application</param> - /// <returns>Returns true if package is preloaded. Otherwise return false.</returns> + /// <param name="applicationId">ID of the application.</param> + /// <returns>Returns true if the package is preloaded, otherwise false.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.info</privilege> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> + /// <exception cref="ArgumentException">Thrown when the failed input package ID is invalid.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> public static bool IsPreloadPackageByApplicationId(string applicationId) { bool isPreloadPackage; @@ -902,13 +902,13 @@ namespace Tizen.Applications } /// <summary> - /// Compare certificate of two packages + /// Compares the certificate of the two packages. /// </summary> - /// <param name="lhsPackageId">package id to compare</param> - /// <param name="rhsPackageId">package id to be compared</param> + /// <param name="lhsPackageId">Package ID to compare.</param> + /// <param name="rhsPackageId">Package ID to be compared.</param> /// <returns>Returns certificate comparison result.</returns> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> + /// <exception cref="ArgumentException">Thrown when the failed input package ID is invalid.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> public static CertCompareResultType CompareCertInfo(string lhsPackageId, string rhsPackageId) { Interop.PackageManager.CertCompareResultType compareResult; @@ -922,13 +922,13 @@ namespace Tizen.Applications } /// <summary> - /// Compare certificate of two packages which contain each given application id + /// Compares the certificate of the two packages which contain each given application ID. /// </summary> - /// <param name="lhsApplicationId">application id to compare</param> - /// <param name="rhsApplicationId">application id to be compared</param> + /// <param name="lhsApplicationId">Application ID to compare.</param> + /// <param name="rhsApplicationId">Application ID to be compared.</param> /// <returns>Returns certificate comparison result.</returns> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error</exception> + /// <exception cref="ArgumentException">Thrown when the failed input package ID is invalid.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> public static CertCompareResultType CompareCertInfoByApplicationId(string lhsApplicationId, string rhsApplicationId) { Interop.PackageManager.CertCompareResultType compareResult; @@ -947,16 +947,16 @@ namespace Tizen.Applications public static class Drm { /// <summary> - /// Generates request for getting license + /// Generates a request for getting the license. /// </summary> - /// <param name="responseData">Response data string of the purchase request</param> - /// <returns>Returns package drm information of given response data which contains require data and license url</returns> + /// <param name="responseData">Response data string of the purchase request.</param> + /// <returns>Returns the package DRM information of a given response data which contains the required data and license URL.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> - /// <exception cref="SystemException">Thrown when method failed due to internal system error</exception> + /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> + /// <exception cref="SystemException">Thrown when the method failed due to an internal system error.</exception> public static PackageDrm GenerateLicenseRequest(string responseData) { return PackageDrm.GenerateLicenseRequest(responseData); @@ -964,16 +964,16 @@ namespace Tizen.Applications } /// <summary> - /// Registers encrypted license + /// Registers the encrypted license. /// </summary> - /// <param name="responseData">The response data string of the rights request</param> - /// <returns>Returns true if succeed. Otherwise return false</returns> + /// <param name="responseData">The response data string of the rights request.</param> + /// <returns>Returns true if succeeds, otherwise false.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> - /// <exception cref="SystemException">Thrown when method failed due to internal system error</exception> + /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> + /// <exception cref="SystemException">Thrown when the method failed due to internal system error.</exception> public static bool RegisterLicense(string responseData) { Interop.PackageManager.ErrorCode err = Interop.PackageManager.PackageManagerDrmRegisterLicense(responseData); @@ -986,17 +986,17 @@ namespace Tizen.Applications } /// <summary> - /// Decrypts contents which is encrypted + /// Decrypts the contents which are encrypted. /// </summary> - /// <param name="drmFilePath">Drm file path</param> - /// <param name="decryptedFilePath">Decrypted file path</param> - /// <returns>Returns true if succeed. Otherwise return false</returns> + /// <param name="drmFilePath">Drm file path.</param> + /// <param name="decryptedFilePath">Decrypted file path.</param> + /// <returns>Returns true if succeeds, otherwise false.</returns> /// <privilege>http://tizen.org/privilege/packagemanager.admin</privilege> /// <privlevel>platform</privlevel> - /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid</exception> - /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method</exception> - /// <exception cref="UnauthorizedAccessException">Thrown when app does not have privilege to access this method</exception> - /// <exception cref="SystemException">Thrown when method failed due to internal system error</exception> + /// <exception cref="ArgumentException">Thrown when failed when input package ID is invalid.</exception> + /// <exception cref="OutOfMemoryException">Thrown when there is not enough memory to continue the execution of the method.</exception> + /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception> + /// <exception cref="SystemException">Thrown when the method failed due to an internal system error.</exception> public static bool DecryptPackage(string drmFilePath, string decryptedFilePath) { Interop.PackageManager.ErrorCode err = Interop.PackageManager.PackageManagerDrmDecryptPackage(drmFilePath, decryptedFilePath); diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs index ba0466f..c840970 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// PackageManagerEventArgs class. This class is an event arguments of the InstallProgressChanged, UninstallProgressChanged and UpdateProgressChanged events. + /// PackageManagerEventArgs class. This class is an event arguments of the InstallProgressChanged, UninstallProgressChanged, and UpdateProgressChanged events. /// </summary> public class PackageManagerEventArgs : EventArgs { @@ -37,17 +37,17 @@ namespace Tizen.Applications } /// <summary> - /// Type of the package to be installed, uninstalled or updated + /// Type of the package to be installed, uninstalled, or updated. /// </summary> public PackageType PackageType { get { return _packageType; } } /// <summary> - /// package ID to be installed, uninstalled or updated + /// Package ID to be installed, uninstalled, or updated. /// </summary> public string PackageId { get { return _packageId; } } /// <summary> - /// Current state of the request to the package manager + /// Current state of the request to the package manager. /// </summary> public PackageEventState State { get { return _state; } } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs index 7269f74..b7d4b15 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// This class has the read only properties to get package size information. + /// This class has read-only properties to get the package size information. /// </summary> public class PackageSizeInformation { @@ -33,32 +33,32 @@ namespace Tizen.Applications private PackageSizeInformation() { } /// <summary> - /// Data size for package. + /// Data size for the package. /// </summary> public long DataSize { get { return _dataSize; } } /// <summary> - /// Cache size for package. + /// Cache size for the package. /// </summary> public long CacheSize { get { return _cacheSize; } } /// <summary> - /// Application size for package. + /// Application size for the package. /// </summary> public long AppSize { get { return _appSize; } } /// <summary> - /// External data size for package. + /// External data size for the package. /// </summary> public long ExternalDataSize { get { return _externalDataSize; } } /// <summary> - /// External cache size for package. + /// External cache size for the package. /// </summary> public long ExternalCacheSize { get { return _externalCacheSize; } } /// <summary> - /// External application size for package. + /// External application size for the package. /// </summary> public long ExternalAppSize { get { return _externalAppSize; } } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs index e8a0042..227db5f 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs @@ -19,21 +19,21 @@ using System; namespace Tizen.Applications { /// <summary> - /// Enumeration for package type. + /// Enumeration for the package types. /// </summary> public enum PackageType { UNKNOWN, /// <summary> - /// Tizen native application package + /// Tizen native application package. /// </summary> TPK, /// <summary> - /// Tizen web/ hybrid application Package + /// Tizen web/hybrid application package. /// </summary> WGT, /// <summary> - /// It's a special meaning type to represent the tizen application package which is installed using rpm spec. + /// A special meaning type to represent the Tizen application package which is installed using the RPM spec. /// Only some preloaded packages can have this type. /// </summary> RPM diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs b/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs index c4a4e2f..d9e2083 100644 --- a/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs @@ -19,20 +19,20 @@ using System; namespace Tizen.Applications { /// <summary> - /// Enumeration for permission type. + /// Enumeration for the permission types. /// </summary> public enum PermissionType { /// <summary> - /// Permission is normal + /// Permission is normal. /// </summary> Normal, /// <summary> - /// Permission is signature + /// Permission is signature. /// </summary> Signature, /// <summary> - /// Permission is privilege + /// Permission is privilege. /// </summary> Privilege } diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerHandle.cs b/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerHandle.cs index 15e0c82..c05653b 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerHandle.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerHandle.cs @@ -39,7 +39,7 @@ namespace Tizen.Applications /// <summary> /// Executes the code required to free the SafePackageManagerHandle. /// </summary> - /// <returns>true if the handle is released successfully</returns> + /// <returns>True if the handle is released successfully.</returns> protected override bool ReleaseHandle() { Interop.PackageManager.PackageManagerDestroy(handle); diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerRequestHandle.cs b/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerRequestHandle.cs index add74f5..60a2bfd 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerRequestHandle.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/SafePackageManagerRequestHandle.cs @@ -39,7 +39,7 @@ namespace Tizen.Applications /// <summary> /// Executes the code required to free the SafePackageManagerRequestHandle. /// </summary> - /// <returns>true if the handle is released successfully</returns> + /// <returns>True if the handle is released successfully.</returns> protected override bool ReleaseHandle() { Interop.PackageManager.PackageManagerRequestDestroy(handle); diff --git a/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs b/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs index 8246188..040c1fb 100755 --- a/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs +++ b/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs @@ -17,7 +17,7 @@ namespace Tizen.Applications { /// <summary> - /// Enumeration for storage type. + /// Enumeration for the storage types. /// </summary> public enum StorageType { diff --git a/Tizen.Applications.Preference/Interop/Interop.Preference.cs b/Tizen.Applications.Preference/Interop/Interop.Preference.cs index dd98962..96958eb 100755 --- a/Tizen.Applications.Preference/Interop/Interop.Preference.cs +++ b/Tizen.Applications.Preference/Interop/Interop.Preference.cs @@ -19,12 +19,12 @@ using System.Runtime.InteropServices; using Tizen.Applications; /// <summary> -/// Contains Interop declarations of Preference classes. +/// Contains interop declarations of the preference classes. /// </summary> internal static partial class Interop { /// <summary> - /// Contains Interop declarations of Preference device API. + /// Contains interop declarations of the preference device API. /// </summary> internal static partial class Preference { diff --git a/Tizen.Applications.Preference/Tizen.Applications/Preference.cs b/Tizen.Applications.Preference/Tizen.Applications/Preference.cs index 4fd6e79..742f132 100755 --- a/Tizen.Applications.Preference/Tizen.Applications/Preference.cs +++ b/Tizen.Applications.Preference/Tizen.Applications/Preference.cs @@ -21,8 +21,8 @@ using Tizen.Internals.Errors; namespace Tizen.Applications { /// <summary> - /// The Preference class provides APIs to store and retrieve application specific data/preference. A preference is saved in the form of a key-value pair. - /// Keys are always text strings and value can be any one of four types: integer, double, string and boolean. + /// The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair. + /// Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean. /// </summary> public static class Preference { @@ -46,10 +46,10 @@ namespace Tizen.Applications } /// <summary> - /// Retrieves all keys of the application preferences + /// Retrieves all keys of the application preferences. /// </summary> /// <value> - /// The list of keys + /// The list of keys. /// </value> /// <example> /// <code> @@ -82,10 +82,10 @@ namespace Tizen.Applications /// Gets the event context for the given key. /// </summary> /// <seealso cref="EventContext"/> - /// <param name="key">The preference key</param> - /// <returns>The event context of respective key</returns> - /// <exception cref="KeyNotFoundException">Thrown if the key is not found</exception> - /// <exception cref="ArgumentException">Thrown if the key is an invalid parameter.</exception> + /// <param name="key">The preference key.</param> + /// <returns>The event context of respective key.</returns> + /// <exception cref="KeyNotFoundException">Thrown if the key is not found.</exception> + /// <exception cref="ArgumentException">Thrown if the key is invalid parameter.</exception> /// <example> /// <code> /// private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) @@ -129,10 +129,10 @@ namespace Tizen.Applications /// <summary> /// Checks whether the given key exists in the preference. /// </summary> - /// <param name="key">The name of the key to check</param> - /// <returns>true if the key exists in the preference, otherwise false</returns> + /// <param name="key">The name of the key to check.</param> + /// <returns>True if the key exists in the preference, otherwise false.</returns> /// <exception cref="ArgumentException">Thrown if the key is an invalid parameter.</exception> - /// <exception cref="IOException">Thrown when method failed due to internal IO error.</exception> + /// <exception cref="IOException">Thrown when the method failed due to an internal I/O error.</exception> /// <example> /// <code> /// Preference.Set("active_user", "Joe"); @@ -161,13 +161,13 @@ namespace Tizen.Applications /// Sets a key-value pair representing the preference. /// </summary> /// <remarks> - /// If the key already exists in the Preference, old value will be overwritten with new value. - /// Data types supported for value are: integer, double, string and bool. + /// If the key already exists in the preference, the old value will be overwritten with a new value. + /// Data types for supported values are: integer, double, string, and bool. /// </remarks> - /// <param name="key">The name of the key to create/modigy</param> + /// <param name="key">The name of the key to create/modify./param> /// <param name="value">The value corresponding to the key.</param> /// <exception cref="ArgumentException">Thrown if the key is an invalid parameter.</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> /// <example> /// <code> /// Preference.Set("Option_enabled", true); @@ -227,11 +227,11 @@ namespace Tizen.Applications /// Note that this is a generic method. /// </summary> /// <typeparam name="T">The generic type to return.</typeparam> - /// <param name="key">The key of the preference</param> + /// <param name="key">The key of the preference.</param> /// <returns>The value of the preference item if it is of the specified generic type.</returns> - /// <exception cref="KeyNotFoundException">Thrown if the key is not found</exception> + /// <exception cref="KeyNotFoundException">Thrown if the key is not found.</exception> /// <exception cref="ArgumentException">Thrown if the key is an invalid parameter.</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> /// <example> /// <code> /// bool exists = Preference.Contains("active_user"); @@ -288,9 +288,9 @@ namespace Tizen.Applications /// <summary> /// Removes any preference value with the given key. /// </summary> - /// <param name="key">The key to remove</param> - /// <exception cref="KeyNotFoundException">Thrown if the key is not found</exception> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error.</exception> + /// <param name="key">The key to remove.</param> + /// <exception cref="KeyNotFoundException">Thrown if the key is not found.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> /// <example> /// <code> /// bool exists = Preference.Contains("active_user"); @@ -311,9 +311,9 @@ namespace Tizen.Applications } /// <summary> - /// Removes all key-value pairs from the preference. + /// Removes all the key-value pairs from the preference. /// </summary> - /// <exception cref="System.IO.IOException">Thrown when method failed due to internal IO error.</exception> + /// <exception cref="System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception> /// <example> /// <code> /// Preference.Set("Option_enabled", true); @@ -354,7 +354,7 @@ namespace Tizen.Applications } /// <summary> - /// The class manages event handlers of preference keys. The class enables having event handlers for individual preference keys. + /// The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys. /// </summary> public class EventContext { @@ -366,10 +366,10 @@ namespace Tizen.Applications } /// <summary> - /// Occurs whenever there is change in the value of preference key. + /// Occurs whenever there is a change in the value of a preference key. /// </summary> /// <exception cref="System.ArgumentException">Thrown when the key does not exist or when there is an invalid parameter.</exception> - /// <exception cref="System.InvalidOperationException">Thrown when the Bundle instance has been disposed.</exception> + /// <exception cref="System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception> /// <example> /// <code> /// private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) diff --git a/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs b/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs index 5386c77..99f81dd 100755 --- a/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs +++ b/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Applications { /// <summary> - /// This class is an event arguments of the PreferenceChanged events. + /// This class is an event argument of the PreferenceChanged event. /// </summary> public class PreferenceChangedEventArgs : EventArgs { diff --git a/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs b/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs index d8742c1..e039c70 100755 --- a/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs +++ b/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs @@ -19,12 +19,12 @@ using Tizen.Applications.CoreBackend; namespace Tizen.Applications { /// <summary> - /// Represents a service application. + /// Represents the service applications. /// </summary> public class ServiceApplication : CoreApplication { /// <summary> - /// Initializes ServiceApplication class. + /// Initializes the ServiceApplication class. /// </summary> public ServiceApplication() : base(new ServiceCoreBackend()) { diff --git a/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs b/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs index fd136b1..d490b2c 100755 --- a/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs +++ b/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs @@ -23,20 +23,20 @@ using System.Threading.Tasks; namespace Tizen.Applications { /// <summary> - /// The class helps you create and show ToastMessage which is a view quick message for the user + /// The class helps you to create and show the ToastMessage which is a view quick message for the user. /// </summary> public sealed class ToastMessage { /// <summary> - /// Gets and sets message to post ToastMessage + /// Gets and sets a message to post the ToastMessage. /// </summary> public string Message { get; set; } /// <summary> - /// Posts a message on a toast popup + /// Posts a message on a toast pop-up. /// </summary> - /// <exception cref="ArgumentNullException">Thrown when Message is null</exception> + /// <exception cref="ArgumentNullException">Thrown when the message is null.</exception> /// <example> /// <code> /// ToastMessage toast = new ToastMessage diff --git a/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs b/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs index 03256e7..e036c14 100755 --- a/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs +++ b/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs @@ -21,7 +21,7 @@ using Tizen.Applications.CoreBackend; namespace Tizen.Applications { /// <summary> - /// Represents an application that have UI screen. The events for resuming and pausing are provided. + /// Represents an application that has an UI screen. The events for resuming and pausing are provided. /// </summary> public class CoreUIApplication : CoreApplication { @@ -29,7 +29,7 @@ namespace Tizen.Applications /// Initializes the CoreUIApplication class. /// </summary> /// <remarks> - /// Default backend for UI application will be used. + /// The default backend for the UI application will be used. /// </remarks> public CoreUIApplication() : base(new UICoreBackend()) { @@ -39,9 +39,9 @@ namespace Tizen.Applications /// Initializes the CoreUIApplication class. /// </summary> /// <remarks> - /// If want to change the backend, use this constructor. + /// If you want to change the backend, use this constructor. /// </remarks> - /// <param name="backend">The backend instance implementing ICoreBacked interface.</param> + /// <param name="backend">The backend instance implementing the ICoreBacked interface.</param> public CoreUIApplication(ICoreBackend backend) : base(backend) { } @@ -59,7 +59,7 @@ namespace Tizen.Applications /// <summary> /// Runs the UI application's main loop. /// </summary> - /// <param name="args">Arguments from commandline.</param> + /// <param name="args">Arguments from the commandline.</param> public override void Run(string[] args) { Backend.AddEventHandler(EventType.PreCreated, OnPreCreate); @@ -69,14 +69,14 @@ namespace Tizen.Applications } /// <summary> - /// Overrides this method if want to handle behavior before calling OnCreate(). + /// Overrides this method if you want to handle the behavior before calling OnCreate(). /// </summary> protected virtual void OnPreCreate() { } /// <summary> - /// Overrides this method if want to handle behavior when the application is resumed. + /// Overrides this method if you want to handle the behavior when the application is resumed. /// If base.OnResume() is not called, the event 'Resumed' will not be emitted. /// </summary> protected virtual void OnResume() @@ -85,7 +85,7 @@ namespace Tizen.Applications } /// <summary> - /// Overrides this method if want to handle behavior when the application is paused. + /// Overrides this method if you want to handle the behavior when the application is paused. /// If base.OnPause() is not called, the event 'Paused' will not be emitted. /// </summary> protected virtual void OnPause() |