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#
                
                    Copy
                    
                
            
public class Alarm

Inheritance: Object

Alarm

Examples


                
                
                    Copy
                    
                
            
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


                C#
                
                    Copy
                    
                
            
public AppControl AlarmAppControl { get; }

Property Value

Type	Description
AppControl

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/alarm.get

View Source

AlarmId

The alarm ID uniquely identifies an alarm.

Declaration


                C#
                
                    Copy
                    
                
            
public int AlarmId { get; }

Property Value

Type	Description
System.Int32

API Level: 3

View Source

Global

Gets whether the alarm will launch global application or not.

Declaration


                C#
                
                    Copy
                    
                
            
public bool Global { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/alarm.sethttp://tizen.org/privilege/alarm.get

View Source

Period

Gets the period of time between the recurrent alarms.

Declaration


                C#
                
                    Copy
                    
                
            
public int Period { get; }

Property Value

Type	Description
System.Int32

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/alarm.get

View Source

ScheduledDate

Gets the scheduled time.

Declaration


                C#
                
                    Copy
                    
                
            
public DateTime ScheduledDate { get; }

Property Value

Type	Description
System.DateTime

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/alarm.get

View Source

WeekFlag

Gets the recurrence days of the week.

Declaration


                C#
                
                    Copy
                    
                
            
public AlarmWeekFlag WeekFlag { get; }

Property Value

Type	Description
AlarmWeekFlag

Remarks

week_flag may be a combination of days, like Tuesday | Friday.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/alarm.get

Methods

View Source

Cancel()

Cancels the specific alarm.

Declaration


                C#
                
                    Copy
                    
                
            
public 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.
System.InvalidOperationException	Thrown in case of any internal error.