Class DriveWorksLiveClient

The DriveWorks Live Client provides a client-side framework with a range of functions for interacting with the DriveWorks Live Integration Theme.

Hierarchy

  • DriveWorksLiveClient

Constructors

constructor

Accessors

apiUrl clientConfig connection downloadStyle responseErrorDelegate responseSuccessDelegate sessionId

Methods

addChildSpecification addItemToList cancelSpecification copyItemListItem createSpecification createSpecificationById deleteListItem editItemListItem getAbsoluteUrl getActiveFormTasks getAllSpecifications getAllSpecificationsByProjectName getAllSpecificationsBySpecificationProperty getAllSpecificationsByStateName getAllSpecificationsCreatedBetween getAllSpecificationsEditedBetween getAllSpecificationsWithProperties getCurrentUser getDriveAppByAlias getDriveApps getGroupTable getGroupTables getProject getProjects getSpecification getSpecificationActions getSpecificationById getSpecificationByName getSpecificationConstantByName getSpecificationConstants getSpecificationDocumentById getSpecificationDocumentUrl getSpecificationDocuments getSpecificationFormData getSpecificationOperationByName getSpecificationProperties getSpecificationReportById getSpecificationReportJson getSpecificationReportUrl getSpecificationReports getSpecificationTransitionByName getSpecificationVariableByName getSpecificationVariables invokeChildSpecificationOperation invokeChildSpecificationTransition invokeDialogCancel invokeDialogOk invokeOperation invokeTransition loginGroup loginSSO logoutAllGroups logoutGroup moveChildSpecificationListItem moveItemListItem navigateHyperlink navigateSpecification openDialog removeChildSpecificationListItem requestPreview requestScreenshot runControlMacro runDriveApp runMacro runTouchPointMacro setChildSpecificationListSelectedIndex setFormContainerSize setHostedSpecificationFormContainerSize setItemListSelectedIndex startSpecification updateConstantValue updateGroupLogin

Constructors

constructor

Accessors

apiUrl

  • get apiUrl(): string

  • Gets the url of the Integration Theme host.

    Returns string

clientConfig

connection

  • get connection(): any

  • Gets the persistent connection to the Live server.

    Returns any

downloadStyle

  • get downloadStyle(): undefined | "cookie" | "header" | "query-string"

  • Gets the method in which downloads should be authenticated.

    Returns undefined | "cookie" | "header" | "query-string"

responseErrorDelegate

  • get responseErrorDelegate(): ((response) => boolean)

  • Gets the function to call when an error response is received from the server.

    Returns ((response) => boolean)

      • (response): boolean

      • Parameters

        Returns boolean

  • set responseErrorDelegate(delegate): void

  • Sets the function to call when an error response is received from the server.

    Return True to skip default response handling.

    Parameters

    • delegate: ((response) => boolean)
        • (response): boolean

        • Parameters

          Returns boolean

    Returns void

responseSuccessDelegate

  • get responseSuccessDelegate(): ((response) => void)

  • Gets the function to call when a successful response is received from the server.

    Returns ((response) => void)

      • (response): void

      • Parameters

        Returns void

  • set responseSuccessDelegate(delegate): void

  • Sets the function to call when a successful response is received from the server.

    Parameters

    • delegate: ((response) => void)
        • (response): void

        • Parameters

          Returns void

    Returns void

sessionId

  • get sessionId(): undefined | string

  • Gets the unique id associated with the current session created through the DriveWorksLiveClient.

    Returns undefined | string

  • set sessionId(id): void

  • Sets the unique session id.

    Parameters

    • id: undefined | string

    Returns void

Methods

addChildSpecification

  • Adds a new child specification from the chosen project to a Child Specification List control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    • projectName: string

      The name of the project that the child specification will be created from.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if childSpecificationListControlName is null or empty.

    Throws

    ArgumentException if projectName is null or empty.

addItemToList

  • Adds an item with the specified form name to an Item List control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • itemListControlName: string

      The name of the Item List control.

    • formName: string

      The name of the form that the added dialog will show.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if itemListControlName is null or empty.

    Throws

    ArgumentException if formName is null or empty.

cancelSpecification

  • Cancels a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to cancel.

    Returns Promise<ApiResponse>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

copyItemListItem

  • Copies an item from an Item List control with the specified form name.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • itemListControlName: string

      The name of the Item List control.

    • formName: string

      The name of the form which represents the type of item to copy.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if itemListControlName is null or empty.

    Throws

    ArgumentException if formName is null or empty.

createSpecification

  • Starts a new specification from the project and group and returns a new Specification.

    Parameters

    • groupAlias: string

      The alias of the group that the project belongs to.

    • projectName: string

      The name of the project to start a specification from.

    Returns Promise<Specification>

createSpecificationById

  • Returns a new Specification based on the supplied specification id.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification.

    Returns Specification

deleteListItem

  • Deletes the currently selected item from an Item List control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • itemListControlName: string

      The name of the Item List control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if itemListControlName is null or empty.

editItemListItem

  • Edits an item from an Item List control with the specified form name.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • itemListControlName: string

      The name of the Item List control.

    • formName: string

      The name of the form which represents the type of item to edit.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if itemListControlName is null or empty.

    Throws

    ArgumentException if formName is null or empty.

getAbsoluteUrl

  • Creates and returns an absolute url for an endpoint based on the apiUrl() of the DriveWorksLiveClient.

    Parameters

    • endpoint: string

      The url segment representing an endpoint.

    Returns string

getActiveFormTasks

  • Gets the tasks for the specification's active form or dialog.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the form tasks from.

    Returns Promise<TaskList>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getAllSpecifications

  • Gets all specifications from the group, with an optional OData query to filter the results.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • oDataQueryString: string = ""

      The optional OData query string, e.g. "$orderby=DateCreated desc".

    Returns Promise<SpecificationData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

getAllSpecificationsByProjectName

  • Gets all specifications from the group that belong to the project.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • projectName: string

      The name of the project that the specifications belong to.

    Returns Promise<SpecificationData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if projectName is null or empty.

getAllSpecificationsBySpecificationProperty

  • Gets all Specifications from the group that have Specification Properties matching the given value.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • specificationProperty: string

      The name of the Specification Property.

    • value: string

      The Specification Property value to be searched.

    Returns Promise<SpecificationData[]>

getAllSpecificationsByStateName

  • Gets all specifications from the group that are in the provided state.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • stateName: string

      The name of the state that the specifications should be in.

    Returns Promise<SpecificationData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if stateName is null or empty.

getAllSpecificationsCreatedBetween

  • Gets all specifications from the group that were created between a start and end date.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • startDate: string

      The start of the date range for when specifications were created. This should be in ISO format.

    • endDate: string

      The end of the date range for when specifications were created. This should be in ISO format.

    Returns Promise<SpecificationData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if startDate is null or empty.

    Throws

    ArgumentException if endDate is null or empty.

getAllSpecificationsEditedBetween

  • Gets all specifications from the group that were edited between a start and end date.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • startDate: string

      The start of the date range for when the specifications were edited. This should be in ISO format.

    • endDate: string

      The end of the date range for when the specifications were edited. This should be in ISO format.

    Returns Promise<SpecificationData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if startDate is null or empty.

    Throws

    ArgumentException if endDate is null or empty.

getAllSpecificationsWithProperties

  • Gets all specifications and specification properties from the group, with an optional OData query to filter the results.

    Parameters

    • groupAlias: string

      The alias of the group containing the specifications to retrieve.

    • oDataQueryString: string = ""

      The optional OData query string, e.g. "$orderby=DateCreated desc".

    Returns Promise<SpecificationData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

getCurrentUser

  • Gets details of the current user.

    Parameters

    • groupAlias: string

      The alias of the group to check.

    • Optional includeTeams: boolean = false

      Whether to include team information in the response data.

    Returns Promise<UserDetails>

    Throws

    ArgumentException if groupAlias is null or empty.

getDriveAppByAlias

  • Gets a DriveApp that the current user has permission to run with the provided unique identifier from the group.

    Parameters

    • groupAlias: string

      The alias of the group that the DriveApp belongs to.

    • driveAppAlias: string

      The alias name of the DriveApp to retrieve.

    Returns Promise<DriveAppData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if driveAppAlias is null or empty.

getDriveApps

  • Gets all of the DriveApps that the current user can run.

    Parameters

    • groupAlias: string

      The alias of the group for which you wish to retrieve DriveApps from.

    • oDataQueryString: string = ""

      The optional OData query string, e.g. "$orderby=Name desc".

    Returns Promise<DriveAppData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

getGroupTable

  • Gets a group table with the provided name for a specified group.

    Parameters

    • groupAlias: string

      The alias of the group for which you wish to retrieve group tables from.

    • tableName: string

      The name of the group table to retrieve.

    Returns Promise<GroupTableData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if tableName is null or empty.

getGroupTables

  • Gets all group tables for a specified group.

    Parameters

    • groupAlias: string

      The alias of the group for which you wish to retrieve group tables from.

    Returns Promise<GroupTableData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

getProject

  • Gets a project from the specified unique id.

    Parameters

    • groupAlias: string

      The alias of the group for which you wish to retrieve the project from.

    • projectId: string

      The unique id of the project that you wish to retrieve.

    Returns Promise<ProjectData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if projectId is null or empty.

getProjects

  • Gets all of the projects for a specified group.

    Parameters

    • groupAlias: string

      The alias of the group for which you wish to retrieve projects from.

    • oDataQueryString: string = ""

      The optional OData query string, e.g. "$orderby=Name desc".

    Returns Promise<ProjectData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

getSpecification

  • Gets a specification with the provided unique identifier from the group, and returns a new Specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification to retrieve.

    • specificationId: string | number

      The unique id of the specification that you wish to retrieve.

    Returns Promise<Specification>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationActions

  • Gets all of the operations and transitions for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the actions to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the actions from.

    Returns Promise<ActionData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationById

  • Gets a specification with the provided unique identifier from the group.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve.

    • Optional includeSpecificationProperties: boolean = false

      Whether Specification Properties should be retrieved.

    Returns Promise<SpecificationData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationByName

  • Gets a specification with the provided name from the group.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification to retrieve.

    • specificationName: string

      The name of the specification to retrieve.

    • Optional includeSpecificationProperties: boolean = false

      Whether Specification Properties should be retrieved.

    Returns Promise<SpecificationData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationName is null or empty.

getSpecificationConstantByName

  • Gets a constant with the provided name that belongs to a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the constant to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the constant from.

    • constantName: string

      The name of the constant to retrieve.

    Returns Promise<ConstantData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if constantName is null or empty.

getSpecificationConstants

  • Gets all constants for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the constants to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the constants from.

    Returns Promise<ConstantData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationDocumentById

  • Gets the document with the provided identifier.

    Parameters

    • groupAlias: string

      The alias of the group containing the document to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the document from.

    • documentId: string

      The identifier of the document to retrieve.

    Returns Promise<DocumentData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if documentId is null or empty.

getSpecificationDocumentUrl

  • Gets the download url of a specified document.

    Parameters

    • groupAlias: string

      The alias of the group containing the document.

    • specificationId: string | number

      The unique identifier of the specification that the document belongs to.

    • documentId: string

      The identifier of the document that you wish to retrieve the download url for.

    • resourceName: string

      The name of the document, or the name of a resource within a HTML file, with the provided documentId.

    Returns string

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if documentId is null or empty.

    Throws

    ArgumentException if resourceName is null or empty.

getSpecificationDocuments

  • Gets all documents for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the documents to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the documents from.

    Returns Promise<DocumentData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationFormData

  • Gets a specification's active form data.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the form data for.

    Returns Promise<SpecificationFormData>

    A complete SpecificationFormData.

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationOperationByName

  • Gets information about the chosen operation for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the operation to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the operation from.

    • operationName: string

      The name of the operation to retrieve.

    Returns Promise<ActionData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if operationName is null or empty.

getSpecificationProperties

  • Gets the specification properties for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification properties.

    • specificationId: string | number

      The unique identifier of the specification to retrieve specification properties from.

    Returns Promise<Record<string, string>>

    An object containing 0 or more key value pairs, e.g. {"MyProperty": "MyValue"}.

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationReportById

  • Gets the specification report with the provided identifier.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification report.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the report from.

    • reportId: string

      The identifier of the report to retrieve.

    Returns Promise<ReportData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if reportId is null or empty.

getSpecificationReportJson

  • Gets the chosen specification report in JSON format.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification report.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the report from.

    • reportId: string

      The identifier of the report to retrieve.

    Returns Promise<ReportJsonData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if reportId is null or empty.

getSpecificationReportUrl

  • Gets the download url for the chosen specification report.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification report.

    • specificationId: string | number

      The unique identifier of the specification that the report belongs to.

    • reportId: string

      The identifier of the report to retrieve the download url for.

    Returns string

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if reportId is null or empty.

getSpecificationReports

  • Gets all specification reports for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification reports.

    • specificationId: string | number

      The unique identifier of the specification to retrieve specification reports from.

    Returns Promise<ReportData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

getSpecificationTransitionByName

  • Gets information about the chosen transition for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the transition to retrieve.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the transition from.

    • transitionName: string

      The name of the transition to retrieve.

    Returns Promise<TransitionData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if transitionName is null or empty.

getSpecificationVariableByName

  • Gets a variable with the provided name from a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the variable belongs to.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the variable from.

    • variableName: string

      The name of the variable to retrieve.

    Returns Promise<VariableData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if variableName is null or empty.

getSpecificationVariables

  • Gets all variables for a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the variables belong to.

    • specificationId: string | number

      The unique identifier of the specification to retrieve the variables from.

    Returns Promise<VariableData[]>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

invokeChildSpecificationOperation

  • Invokes an operation on the currently selected specification in a Child Specification List control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    • operationName: string

      The name of the operation to invoke on the selected child specification.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if childSpecificationListControlName is null or empty.

    Throws

    ArgumentException if operationName is null or empty.

invokeChildSpecificationTransition

  • Invokes a transition on the currently selected specification in a Child Specification List control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    • transitionName: string

      The name of the transition to invoke on the selected child specification.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if childSpecificationListControlName is null or empty.

    Throws

    ArgumentException if transitionName is null or empty.

invokeDialogCancel

  • Cancels the active dialog and closes it.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the dialog belongs to.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

invokeDialogOk

  • Confirms the chosen items on a dialog and closes it.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the dialog belongs to.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

invokeOperation

  • Invokes an operation on a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to invoke the operation on.

    • operationName: string

      The name of the operation to invoke.

    Returns Promise<ActionResult>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if operationName is null or empty.

invokeTransition

  • Invokes a transition on a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to invoke the transition on.

    • transitionName: string

      The name of the transition to invoke.

    Returns Promise<ActionResult>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if transitionName is null or empty.

loginGroup

  • Logs in to the group with the supplied credentials.

    Parameters

    • groupAlias: string

      The alias of the group to log in to.

    • Optional credentials: GroupCredentials

      The login credentials to use. If none are supplied, the credentials of the groupAlias will be used.

    Returns Promise<SessionData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if the credentials object does not implement the GroupCredentials interface.

loginSSO

  • Logs into the group using the OAuth2 authentication flow. This method is only supported in shared groups.

    Parameters

    • groupAlias: string

      The alias of the group to log in to.

    • Optional callback: ((sessionData) => void)

      An optional callback method that will be invoked when login has successfully completed.

        • (sessionData): void

        • Parameters

          Returns void

    Returns Promise<SessionData>

logoutAllGroups

  • Logs out of all groups in the session that are currently logged in.

    Returns Promise<number>

logoutGroup

  • Logs out of the current session of the group.

    Parameters

    • groupAlias: string

      The alias of the group to log out of.

    Returns Promise<number>

    Throws

    ArgumentException if groupAlias is null or empty.

moveChildSpecificationListItem

  • Moves the child specification at the specified index in a Child Specification List control up or down.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    • commandData: MoveListItemCommandData

      The MoveListItemCommandData containing the movement direction and row index to perform the command.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if childSpecificationListControlName is null or empty.

    Throws

    ArgumentException if commandData is null or empty.

    Throws

    ArgumentException if the commandData object does not implement the MoveListItemCommandData interface.

moveItemListItem

  • Moves the item at the specified index in an Item List Control up or down.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • itemListControlName: string

      The name of the Item List control.

    • commandData: MoveListItemCommandData

      The MoveListItemCommandData containing the movement direction and row index to perform the command.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if itemListControlName is null or empty.

    Throws

    ArgumentException if commandData is null or empty.

    Throws

    ArgumentException if the commandData object does not implement the MoveListItemCommandData interface.

navigateHyperlink

  • Navigates to the hyperlink of a Hyperlink control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • hyperlinkControlName: string

      The name of the Hyperlink control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if hyperlinkControlName is null or empty.

navigateSpecification

  • Navigates a specification in the chosen direction.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to navigate.

    • direction: "backward" | "forward"

      The direction to navigate in - "backward" or "forward".

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if direction is null or empty.

    Throws

    ArgumentException if direction contains an invalid value.

openDialog

  • Opens the dialog of a Dialog Button.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • dialogButtonControlName: string

      The name of the Dialog Button control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if dialogButtonControlName is null or empty.

removeChildSpecificationListItem

  • Removes the currently selected child specification from a Child Specification List.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if childSpecificationListControlName is null or empty.

requestPreview

  • Requests a preview from a 3D Preview control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • previewControlName: string

      The name of the 3D Preview control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if previewControlName is null or empty.

requestScreenshot

runControlMacro

  • Runs a macro for a specification control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • controlName: string

      The name of the control to run the macro on.

    • macroData: ControlMacroData

      The ControlMacroData to provide to the macro, including the name of the macro to run.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if controlName is null or empty.

    Throws

    ArgumentException if macroData is null or empty.

    Throws

    ArgumentException if the macroData object does not implement the ControlMacroData interface.

runDriveApp

  • Runs a DriveApp with the provided alias and returns a new Specification.

    Parameters

    • groupAlias: string

      The alias of the group that the DriveApp belongs to.

    • driveAppAlias: string

      The alias name of the DriveApp to create.

    Returns Promise<Specification>

runMacro

  • Runs a macro for a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the macro belongs to.

    • macroData: SpecificationMacroData

      The SpecificationMacroData to provide to the macro, including the name of the macro to run.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if macroData is null or empty.

    Throws

    ArgumentException if the macroData object does not implement the SpecificationMacroData interface.

runTouchPointMacro

  • Runs a touch point macro within a 3D Preview control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • previewControlName: string

      The name of the 3D Preview control.

    • commandData: TouchPointCommandData

      The TouchPointCommandData containing data to run the macro with.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if previewControlName is null or empty.

setChildSpecificationListSelectedIndex

  • Sets the selection of a Child Specification List control to the item at the provided index.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    • index: number

      The index to set as the selected item of the list control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if childSpecificationListControlName is null or empty.

    Throws

    ArgumentException if index is null or empty.

setFormContainerSize

  • Sets the form container size of a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to set the form container size of.

    • height: number

      The height to set the form container to.

    • width: number

      The width to set the form container to.

    • force: boolean = true

      Whether the size change should be applied immediately, or after a delay. Defaults to True.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if height is null or empty.

    Throws

    ArgumentException if width is null or empty.

setHostedSpecificationFormContainerSize

  • Sets the form container size of a hosted specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification to set the form container size of.

    • height: number

      The height to set the form container to.

    • width: number

      The width to set the form container to.

    • force: boolean = true

      Whether the size change should be applied immediately, or after a delay. Defaults to True.

    • specificationHostControlName: string

      The name of the specification host control containing the specification to update.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if height is null or empty.

    Throws

    ArgumentException if width is null or empty.

    Throws

    ArgumentException if specificationHostControlName is null or empty.

setItemListSelectedIndex

  • Sets the selection of an Item List control to the item at the provided index.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the control belongs to.

    • listControlName: string
    • rowIndex: number

      The index to set as the selected item of the list control.

    Returns Promise<unknown>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if listControlName is null or empty.

    Throws

    ArgumentException if rowIndex is null or empty.

startSpecification

  • Starts a specification from the project and group.

    Parameters

    • groupAlias: string

      The alias of the group that the project belongs to.

    • projectName: string

      The name of the project to start a specification from.

    Returns Promise<NewSpecificationData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if projectName is null or empty.

updateConstantValue

  • Updates a constant with the provided value.

    Parameters

    • groupAlias: string

      The alias of the group that the constant belongs to.

    • specificationId: string | number

      The unique identifier of the specification that the constant belongs to.

    • constantName: string

      The name of the constant to update.

    • constantValue: string

      The value to be applied to the constant.

    Returns Promise<ConstantData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if specificationId is null or empty.

    Throws

    ArgumentException if constantName is null or empty.

updateGroupLogin

  • Updates the current login credentials of the group with the supplied credentials.

    Parameters

    • groupAlias: string

      The alias of the group that will have its credentials updated.

    • credentials: GroupCredentials

      The credentials to apply to the group.

    Returns Promise<SessionData>

    Throws

    ArgumentException if groupAlias is null or empty.

    Throws

    ArgumentException if credentials is null or empty.

    Throws

    ArgumentException if the credentials object does not implement the GroupCredentials interface.