K4 InDesign Javascript API Documentation

K4 ServerK4Task

K4 Task

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the K4Task within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4Id string K4 Server ID read-only
k4IsAutomatedTask bool K4 Is Automated Task Flag read-only
k4IsIndependentTask bool K4 Is Independent Task Flag read-only
k4IsLocalTask bool K4 if it is a locally accepted task read-only
k4Name string K4 Name read-only
k4PublicationId string K4 Publication ID read-only
k4TaskInstanceId string K4 Task Instance ID read-only
k4TaskState K4TaskStates K4 Task State read-only
parent The parent of the K4Task (a K4ServerObject or K4ServerData). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → K4Task
k4AcceptTask(
)
  → Object
k4UndoAcceptTask(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → K4Task
Resolves the object specifier, creating an array of object references.
k4AcceptTask(
)
  → Object
K4 Accept Task
k4UndoAcceptTask(
)
K4 undo accept task
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the K4Task.
toSpecifier(
)
  → string
Retrieves the object specifier.