BackgroundTask

Methods:

Property	Type	Access	Description
alerts	Array of 2 TaskAlertType enumerators Array of Strings String	readonly	The alerts encountered while running this task object. Can return: Array of Array of 2 TaskAlertType enumerators or Strings.
documentName	String	readonly	The document name on which this task operates.
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 BackgroundTask.
index	Number	readonly	The index of the BackgroundTask within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
name	String	readonly	The name of the BackgroundTask.
parent	Application	readonly	The parent of the BackgroundTask (a Application).
percentDone	Number	readonly	Progress information for this task.
properties	Object	read/write	A property that allows setting of several properties at the same time.
status	TaskState TaskState.CANCELLED TaskState.CANCELLING TaskState.COMPLETED TaskState.QUEUED TaskState.RUNNING TaskState.WAITING	readonly	The current status of this task object.

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

Adds an event listener.

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

Parameter

Type

Description

eventType

The event type.

handler

JavaScriptFunction

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

captures

This parameter is obsolete. (Optional)

(default: false)

undefined cancelTask ()

Cancels the specified background task.

BackgroundTask getElements ()

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

Varies queryProperty (name:String)

Queries for a particular property in the task metadata.

Parameter	Type	Description
name	String	The task property being queried

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

Removes the event listener.

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