IdleTask

Methods:

remove, insertLabel, extractLabel, toSource, getElements, toSpecifier, addEventListener, removeEventListener

Objects:

Application, Boolean, EventListeners, Events, Number, Object, String,

Property Listing

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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the IdleTask.
parent	Application	readonly	The parent of the IdleTask (a Application).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sleep	Number	read/write	Amount of time to sleep (in milliseconds) before calling this task again. Setting this to zero will cause task to be deleted.

Constants/Events

Name	Type	Access	Description
ON_IDLE	String	readonly	Dispatched at idle time for this IdleTask. This event does not bubble. This event is not cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Adds an event listener.

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

Parameter

Type

Description

eventType

String

The event type.

handler

Varies

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

IdleTask getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined remove ()

Deletes the IdleTask.

Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Removes the event listener.

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