Object

BackgroundTask

background task

Hierarchy

BackgroundTask

Properties

Type	Access	Description
2 TaskAlertType enumerators[] \| Strings[]	readonly	The alerts encountered while running this task object. Can return: Array of Array of 2 TaskAlertType enumerators or Strings.
String	readonly	The document name on which this task operates.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Number	readonly	The unique ID of the BackgroundTask.
Number	readonly	The index of the BackgroundTask within its containing object.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	readonly	The name of the BackgroundTask.
Application	readonly	The parent of the BackgroundTask (a Application).
Number	readonly	Progress information for this task.
Object	read/write	A property that allows setting of several properties at the same time.
TaskState	readonly	The current status of this task object.

→ EventListener

Adds an event listener.

eventType String The event type.

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

captures? Boolean This parameter is obsolete.

→ void

Cancels the specified background task.

→ BackgroundTask[]

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

→ Varies

Queries for a particular property in the task metadata.

name String The task property being queried

→ Boolean

Removes the event listener.

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.

→ String

Generates a string which, if executed, will return the BackgroundTask.

→ String

Retrieves the object specifier.

→ TaskState

Waits for the task to finish.

Properties elsewhere that hold a BackgroundTask.

Method parameters that accept a BackgroundTask.

Methods that return a BackgroundTask.