K4 InDesign Javascript API Documentation

K4 ServerK4QueryResult

K4 Query Result

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 K4QueryResult within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4ServerObjects K4ServerObjects K4 Server Objects read-only
parent K4Publication The parent of the K4QueryResult (a K4Publication). 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(
)
  → K4QueryResult
k4ExecuteAdvancedQuery(
k4QueryId ​[, k4FullTextSearchString] ​[, k4MaxK4Objects])
k4ExecuteSimpleQuery(
k4WorkflowId, k4OutputChannelId, k4IssueId, k4SectionId, k4StatusId ​[, k4FullTextSearchString] ​[, k4MaxK4Objects])
remove(
)
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(
)
  → K4QueryResult
Resolves the object specifier, creating an array of object references.
k4ExecuteAdvancedQuery(
k4QueryId ​[, k4FullTextSearchString] ​[, k4MaxK4Objects])
K4 Execute Advanced Query
k4QueryId string K4 Query ID
k4FullTextSearchString string K4 Full Text Search String (Optional)
k4MaxK4Objects number K4 Max K4 Objects (Optional)
k4ExecuteSimpleQuery(
k4WorkflowId, k4OutputChannelId, k4IssueId, k4SectionId, k4StatusId ​[, k4FullTextSearchString] ​[, k4MaxK4Objects])
K4 Execute Simple Query
k4WorkflowId K4 Workflow ID. Can accept: K4SpecialWorkflow enumerator or String. (Optional)
k4OutputChannelId K4 Output Channel ID. Can accept: K4SpecialOutputChannel enumerator or String. (Optional)
k4IssueId K4 Issue ID. Can accept: K4SpecialIssue enumerator or String. (Optional)
k4SectionId K4 Section ID. Can accept: K4SpecialSection enumerator or String. (Optional)
k4StatusId K4 Status ID. Can accept: K4SpecialStatus enumerator or String. (Optional)
k4FullTextSearchString string K4 Full Text Search String (Optional)
k4MaxK4Objects number K4 Max K4 Objects (Optional)
remove(
)
Deletes the K4QueryResult.
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 K4QueryResult.
toSpecifier(
)
  → string
Retrieves the object specifier.