Class Alarm
Definition
- Namespace:
- Tizen.Applications
- Assembly:
- Tizen.Applications.Alarm.dll
- API Level:
- 3
The alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future.
C#Copypublic class Alarm
- Inheritance
-
System.ObjectAlarm
Examples
Copypublic class AlarmExample { /// ... IEnumerable < Alarm > alarms = AlarmManager.GetAllScheduledAlarms(); alarms[0].Cancel(); }
Properties
Declaration
C#Copypublic AppControl AlarmAppControl { get; }
Property Value
Type | Description |
---|---|
AppControl |
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/alarm.get
Declaration
C#Copypublic int AlarmId { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
API Level: 3
Declaration
C#Copypublic bool Global { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/alarm.sethttp://tizen.org/privilege/alarm.get
Declaration
C#Copypublic int Period { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
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.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/alarm.sethttp://tizen.org/privilege/alarm.get
Declaration
C#Copypublic DateTime ScheduledDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Remarks
The SchduleDate
property setter is available since API Level 6.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/alarm.sethttp://tizen.org/privilege/alarm.get
Declaration
C#Copypublic AlarmWeekFlag WeekFlag { get; set; }
Property Value
Type | Description |
---|---|
AlarmWeekFlag |
Remarks
The WeekFlag
property setter is available since API Level 6.
Weekflag may be a combination of days, like Tuesday | Friday.
If the period was set before, it will be removed and the week recurrence flag will be set.
If the week recurrence flag was set before, it will be overwritten.If it was not, it will be set.
If the Weekflag argument is 0 and the flag was previously set,
the flag attribute will be cleared and the alarm will be changed to one-time.
If the Weekflag argument is 0 and the flag was not set,
or the period was set, the alarm will be unchanged.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/alarm.sethttp://tizen.org/privilege/alarm.get
Methods
Declaration
C#Copypublic void Cancel()
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown in case of an invalid parmaeter. |
UnauthorizedAccessException | Thrown in case of a permission denied due to insufficient privileges. |
InvalidOperationException | Thrown in case of any internal error. |