| Package | com.distriqt.extension.jobscheduler |
| Class | public final class JobScheduler |
| Inheritance | JobScheduler  flash.events.EventDispatcher |
This class represents the JobScheduler extension.
| Property | Defined By | ||
|---|---|---|---|
| implementation : String [read-only]
The implementation currently in use. | JobScheduler | ||
| instance : JobScheduler [static] [read-only]
The singleton instance of the JobScheduler class. | JobScheduler | ||
| isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| JobScheduler | ||
| nativeVersion : String [read-only]
The native version string of the native extension. | JobScheduler | ||
| version : String [read-only]
The version of this extension. | JobScheduler | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
You should not call this directly, but instead use the singleton access
| JobScheduler | ||
cancelTermination():Boolean
Cancel any previously scheduled application terminations. | JobScheduler | ||
dispose():void
Disposes the extension and releases any allocated resources. | JobScheduler | ||
init(key:String):void [static]
Initialises the extension class for use with the provided key. | JobScheduler | ||
scheduleTermination(delay:int):Boolean
Schedule a job to terminate the application in the specified delay. | JobScheduler | ||
| Constant | Defined By | ||
|---|---|---|---|
| EXT_CONTEXT_ID : String = com.distriqt.JobScheduler [static] | JobScheduler | ||
| VERSION : String = 1.1.0 [static] | JobScheduler | ||
| implementation | property |
implementation:String [read-only]
The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:
AndroidiOSdefaultunknown public function get implementation():String| instance | property |
instance:JobScheduler [read-only] The singleton instance of the JobScheduler class.
public static function get instance():JobSchedulerError — If there was a problem creating or accessing the extension, or if the key is invalid
|
| isSupported | property |
isSupported:Boolean [read-only] Whether the current device supports the extensions functionality
public static function get isSupported():Boolean| nativeVersion | property |
nativeVersion:String [read-only]
The native version string of the native extension.
public function get nativeVersion():String| version | property |
version:String [read-only]
The version of this extension.
This should be of the format, MAJOR.MINOR.BUILD
public function get version():String| JobScheduler | () | Constructor |
public function JobScheduler()Constructor You should not call this directly, but instead use the singleton access
| cancelTermination | () | method |
public function cancelTermination():BooleanCancel any previously scheduled application terminations.
ReturnsBoolean — true if successfully cancelled.
|
| dispose | () | method |
public function dispose():void
Disposes the extension and releases any allocated resources. Once this function
has been called, a call to init is neccesary again before any of the
extensions functionality will work.
| init | () | method |
public static function init(key:String):voidInitialises the extension class for use with the provided key.
Parameters
key:String |
Error — If there was a problem creating or accessing the extension, or if the key is invalid
|
| scheduleTermination | () | method |
public function scheduleTermination(delay:int):BooleanSchedule a job to terminate the application in the specified delay.
Parameters
delay:int — Delay in milliseconds until the application will be terminated
|
Boolean — true if successfully scheduled
|
| EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.JobScheduler| VERSION | Constant |
public static const VERSION:String = 1.1.0