Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Tizen.Applications.Alarm] Enhance API descriptions #6359

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,17 @@ public int AlarmId
/// <privilege>http://tizen.org/privilege/alarm.get</privilege>
/// <remarks>
/// The setter for <c>WeekFlag</c> property is available since API Level 6.
/// Weekflag can be a combination of the days of the week, for example Tuesday | Friday.
/// If the period is already set, it will be removed and the week repetition flag will be set.
/// If the week repetition flag is already set, it will be overwritten. If not, it will be set.
/// Weekflag can represent a combination of days of the week, such as Tuesday | Friday.
/// If the period is already set, it will be removed and the week repetition flag will be set instead.
/// If the week repetition flag is already set, it will be overwritten. Otherwise, it will be set.
/// If the Weekflag argument is 0 and the flag is already set,
/// the flag will be cleared and the alarm will be changed to set once.
/// If the Weekflag argument is 0, and the flag is not set or the period is set,
/// the alarm won't be changed.
/// the flag will be cleared and the alarm will be changed to a single occurrence.
/// If the Weekflag argument is 0 and no flag is set or if the period is set,
/// the alarm will remain unchanged.
/// </remarks>
/// <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>
/// <since_tizen> 3 </since_tizen>
public AlarmWeekFlag WeekFlag
{
Expand Down Expand Up @@ -103,6 +106,9 @@ public AlarmWeekFlag WeekFlag
/// <remarks>
/// The <c>SchduleDate</c> property setter is available since API Level 6.
/// </remarks>
/// <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>
/// <since_tizen> 3 </since_tizen>
public DateTime ScheduledDate
{
Expand Down Expand Up @@ -141,19 +147,22 @@ public DateTime ScheduledDate
}

/// <summary>
/// Gets the period of time between the recurrent alarms.
/// Gets or sets the period of time between the recurrent alarms.
/// </summary>
/// <privilege>http://tizen.org/privilege/alarm.set</privilege>
/// <privilege>http://tizen.org/privilege/alarm.get</privilege>
/// <remarks>
/// The <c>Period</c> property setter is available since API Level 6.
/// If the week recurrence flag was set before, it will be removed and the period will be set
/// If the period was set before, it will be overwritten.If it was not, it will be set.
/// If the period was set before, it will be overwritten. If it was not, it will be set.
/// If the @a period argument is 0 and the period was previously set,
/// the period attribute will be cleared and the alarm will be changed to one-time.
/// If the @a period argument is 0 and the period was not set,
/// or the week recurrence flag was set, the alarm will be unchanged.
/// or the week recurrence flag was set, the alarm will remain unchanged.
/// </remarks>
/// <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>
/// <since_tizen> 3 </since_tizen>
public int Period
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public enum AlarmStandardPeriod
}

/// <summary>
/// Mobile devices typically give constant access to information from various sources. Some of this information is best delivered through alarms.
/// 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.
Expand Down Expand Up @@ -149,7 +149,7 @@ internal static DateTime ConvertIntPtrToDateTime(Interop.Alarm.DateTime time)
/// Sets an alarm to be triggered after a specific time.
/// The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds.
/// </summary>
/// <param name="delay">The amount of time before the first execution (in seconds).</param>
/// <param name="delay">The amount of time before the first execution (in seconds). Although this is inexact, the alarm will not fire before this time</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 is used to perform a specific task when the alarm is triggered. </param>
Expand Down Expand Up @@ -330,7 +330,7 @@ public static Alarm CreateAlarm(DateTime dateTime, Notification notification)
/// Sets a notification alarm to be triggered after a specific time.
/// The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds.
/// </summary>
/// <param name="delay">The amount of time before the first execution (in seconds). </param>
/// <param name="delay">The amount of time before the first execution (in seconds). Although this is inexact, the alarm will not fire before this time</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> An alarm instance is created with the set param values.</returns>
Expand Down
Loading