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

View Source

AlarmAppControl

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

Declaration
public AppControl AlarmAppControl { get; }
Property Value
Type Description
AppControl
View Source

AlarmId

The alarm ID uniquely identifies an alarm.

Declaration
public int AlarmId { get; }
Property Value
Type Description
int
View Source

Global

Gets whether the alarm will launch global application or not.

Declaration
public bool Global { get; set; }
Property Value
Type Description
bool
View Source

Period

Gets or sets 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 remain unchanged.

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.
View Source

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.

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.
View Source

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 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 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.

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.

Methods

View Source

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.