IdleTask

An attachable idle task.

IdleTask

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the IdleTask.
index	number	readonly	The index of the IdleTask within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the IdleTask.
parent	Application	readonly	The parent of the IdleTask (a Application).
properties	Object	r/w	A property that allows setting of several properties at the same time.
sleep	number	r/w	Amount of time to sleep (in milliseconds) before calling this task again. Setting this to zero will cause task to be deleted.

Property	Type	Access	Description
ON_IDLE	string	readonly	Dispatched at idle time for this IdleTask. This event does not bubble. This event is not cancelable. (default: onIdle)

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of IdleTask getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the IdleTask.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)