K4 InDesign Javascript API Documentation

K4 ServerK4Publication

K4 Publication

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 K4Publication within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4AssetsFolders K4AssetsFolders K4 Assets Folders read-only
k4FullTextSearchActive bool K4 Full Text Search Active read-only
k4Groups K4Groups K4 User Groups read-only
k4Id string K4 Server ID read-only
k4Issues K4Issues K4 Issues read-only
k4MetaDataDefs K4MetaDataDefs All K4 Meta Data Definitions read-only
k4Name string K4 Name read-only
k4OutputChannels K4OutputChannels K4 Output Channels read-only
k4Queries K4Queries K4 Queries read-only
k4QueryResults K4QueryResults K4 Query Results read-only
k4Renditions K4Renditions K4 Renditions read-only
k4Sections K4Sections All K4 Sections of the Issue read-only
k4UserId string K4 User ID read-only
k4UserName string K4 User Name read-only
k4Users K4Users K4 Users read-only
k4Variants K4Variants K4 Variants read-only
k4Workflows K4Workflows K4 Workflows read-only
parent Application The parent of the K4Publication (a Application). 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(
)
  → K4Publication
k4GetStartWfObjectForOtherVariant(
k4WFObjectVariantId)
  → K4StartWorkflowObjectForOtherVariant
k4LogOut(
)
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(
)
  → K4Publication
Resolves the object specifier, creating an array of object references.
k4GetStartWfObjectForOtherVariant(
k4WFObjectVariantId)
  → K4StartWorkflowObjectForOtherVariant
K4 Get Start Workflow Object For Other Variant
k4WFObjectVariantId string K4 Workflow object variant ID
k4LogOut(
)
K4 Log Out
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 K4Publication.
toSpecifier(
)
  → string
Retrieves the object specifier.