Class Alarm

Definition

Namespace:

Tizen.Applications

Assembly:

Tizen.Applications.Alarm.dll

The alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future.

public class Alarm

Inheritance

object

Alarm

Examples

public class AlarmExample
{
    /// ...
    IEnumerable < Alarm > alarms = AlarmManager.GetAllScheduledAlarms();
    alarms[0].Cancel();
}

Properties

AlarmAppControl

Gets the AppControl to be invoked when the the alarm is triggered.

Declaration

public AppControl AlarmAppControl { get; }

Property Value

Type	Description
AppControl

AlarmId

The alarm ID uniquely identifies an alarm.

Declaration

public int AlarmId { get; }

Property Value

Type	Description
int

Global

Gets whether the alarm will launch global application or not.

Declaration

public bool Global { get; set; }

Property Value

Type	Description
bool

Period

Gets the period of time between the recurrent alarms.

Declaration

public int Period { get; set; }

Property Value

Type	Description
int

Remarks

The Period 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 @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.

ScheduledDate

Gets or sets the scheduled time.

Declaration

public DateTime ScheduledDate { get; set; }

Property Value

Type	Description
System.DateTime

Remarks

The SchduleDate property setter is available since API Level 6.

WeekFlag

Gets or sets the recurrence days of the week.

Declaration

public AlarmWeekFlag WeekFlag { get; set; }

Property Value

Type	Description
AlarmWeekFlag

Remarks

The setter for WeekFlag 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. 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.

Methods

Cancel()

Cancels the specific alarm.

Declaration

public void Cancel()

Exceptions

Type	Condition
System.ArgumentException	Thrown in case of an invalid parmaeter.
System.UnauthorizedAccessException	Thrown in case of a permission denied due to insufficient privileges.
System.InvalidOperationException	Thrown in case of any internal error.