Package | com.distriqt.extension.application.alarms |
Interface | public interface AlarmManager extends flash.events.IEventDispatcher |
Property | Defined By | ||
---|---|---|---|
isSupported : Boolean [read-only]
If true the alarm manager functionality is available on this device. | AlarmManager |
Method | Defined By | ||
---|---|---|---|
cancelAlarm(alarm:Alarm):Boolean
Cancels a previously set alarm
| AlarmManager | ||
cancelAlarmById(id:int):Boolean
Cancels a previously set alarm
| AlarmManager | ||
cancelAllAlarms():Boolean
Cancels all previously set alarms
| AlarmManager | ||
register():Boolean
This will register your application to receive alarms and as part of this
process any alarms that were received while your application wasn't running
or received at startup will be dispatched. | AlarmManager | ||
Sets the specified alarm
| AlarmManager |
Event | Summary | Defined By | ||
---|---|---|---|---|
AlarmManager | ||||
AlarmManager |
isSupported | property |
isSupported:Boolean
[read-only]
If true the alarm manager functionality is available on this device.
Generally this will return true on Android and false on other platforms.
public function get isSupported():Boolean
cancelAlarm | () | method |
public function cancelAlarm(alarm:Alarm):Boolean
Cancels a previously set alarm
Parameters
alarm:Alarm — The alarm to clear
|
Boolean — true if the alarm was cleared and false if the alarm could not be found
|
cancelAlarmById | () | method |
public function cancelAlarmById(id:int):Boolean
Cancels a previously set alarm
Parameters
id:int — The id of the alarm to clear
|
Boolean — true if the alarm was cleared and false if the alarm could not be found
|
cancelAllAlarms | () | method |
public function cancelAllAlarms():Boolean
Cancels all previously set alarms
ReturnsBoolean — true if successful
|
register | () | method |
public function register():Boolean
This will register your application to receive alarms and as part of this process any alarms that were received while your application wasn't running or received at startup will be dispatched. You should ensure you have added any relevant event listeners before calling register.
ReturnsBoolean — true if successful and false otherwise
|
setAlarm | () | method |
public function setAlarm(alarm:Alarm):Boolean
Sets the specified alarm
Parameters
alarm:Alarm — Instance of the Alarm class preferably built with an AlarmBuilder .
|
Boolean — true if the alarm was set successfully
|
alarm | Event |
com.distriqt.extension.application.events.AlarmEvent
com.distriqt.extension.applications.events.AlarmEvent.ALARM
alarm_error | Event |
com.distriqt.extension.application.events.AlarmEvent
com.distriqt.extension.applications.events.AlarmEvent.ERROR