InDesign Server2025
API 20.5.0.49
Object

IdleTask

An attachable idle task.

Hierarchy

Application

IdleTask

IdleEvent

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the IdleTask.
Number readonly The index of the IdleTask within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the IdleTask.
Application readonly The parent of the IdleTask (a Application).
Object read/write A property that allows setting of several properties at the same time.
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.

Events

NameDescription
Dispatched at idle time for this IdleTask. This event does not bubble. This event is not cancelable.

Methods

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

Gets the label value associated with the specified key.

key String The key.
IdleTask[]

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

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
void

Deletes the IdleTask.

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a IdleTask.

Parameter of 3

Method parameters that accept a IdleTask.

Return 14

Methods that return a IdleTask.