K4 InDesign Javascript API Documentation

K4 ServerK4WorkflowChannel

K4 Workflow Channel

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 K4WorkflowChannel within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4AssetsFolderIds string K4 Assets Folder IDs read-only
k4FileExtensions string K4 File Extensions read-only
k4Id string K4 Server ID read-only
k4IsSimplifiedTaskWorkflow bool K4 if it is simplified task workflow read-only
k4Name string K4 Name read-only
k4OutputChannelId string K4 Output Channel ID read-only
k4PlacableInInDesign bool K4 Placable in InDesign read-only
k4Position number K4 position read-only
k4PublicationId string K4 Publication ID read-only
k4Statuses K4Statuses K4 Statuses read-only
k4TaskDefinitions K4TaskDefinitions K4 Task Definitions read-only
k4WfDefinitionId string K4 Workflow Definition ID read-only
parent K4Workflow The parent of the K4WorkflowChannel (a K4Workflow). 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(
)
  → K4WorkflowChannel
k4GetStartWfObjectForDocument(
k4Document)
  → K4StartWorkflowObject
k4GetStartWfObjectForFile(
k4FilePath)
  → K4StartWorkflowObject
k4GetStartWfObjectForObject(
k4Object)
  → K4StartWorkflowObject
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(
)
  → K4WorkflowChannel
Resolves the object specifier, creating an array of object references.
k4GetStartWfObjectForDocument(
k4Document)
  → K4StartWorkflowObject
K4 Get Start Workflow Object For Document
k4Document Document K4 Document
k4GetStartWfObjectForFile(
k4FilePath)
  → K4StartWorkflowObject
K4 Get Start Workflow Object For File
k4FilePath string K4 File Path
k4GetStartWfObjectForObject(
k4Object)
  → K4StartWorkflowObject
K4 Get Start Workflow Object For Object
k4Object Object K4 Object
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 K4WorkflowChannel.
toSpecifier(
)
  → string
Retrieves the object specifier.