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

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

apiUrl

  • get apiUrl(): string
  • Gets the url of the Integration Theme host.

    Returns string

clientConfig

connection

  • get connection(): Connection
  • Gets the persistent connection to the Live server.

    Returns Connection

downloadStyle

  • get downloadStyle(): "cookie" | "header" | "query-string"
  • Gets the method in which downloads should be authenticated.

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

sessionId

  • get sessionId(): string
  • Gets the unique id associated with the current user session created through the DriveWorksLiveClient.

    Returns string

Methods

addChildSpecification

  • addChildSpecification(groupAlias: string, specificationId: string, childSpecificationListControlName: string, projectName: string, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

addItemToList

  • addItemToList(groupAlias: string, specificationId: string, itemListControlName: string, formName: string, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

cancelSpecification

  • cancelSpecification(groupAlias: string, specificationId: string): Promise<ApiResponse>
  • Cancels a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

      The unique identifier of the specification to cancel.

    Returns Promise<ApiResponse>

copyItemListItem

  • copyItemListItem(groupAlias: string, specificationId: string, itemListControlName: string, formName: string, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

createSpecification

  • createSpecification(groupAlias: string, projectName: string): Promise<Specification>
  • 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

  • createSpecificationById(groupAlias: string, specificationId: string): Specification
  • 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

      The unique identifier of the specification.

    Returns Specification

deleteListItem

  • deleteListItem(groupAlias: string, specificationId: string, itemListControlName: string, versionId?: string): Promise<FormData>
  • 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

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

    • itemListControlName: string

      The name of the Item List control.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

editItemListItem

  • editItemListItem(groupAlias: string, specificationId: string, itemListControlName: string, formName: string, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

getAbsoluteUrl

  • getAbsoluteUrl(endpoint: string): string
  • 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

  • getActiveFormTasks(groupAlias: string, specificationId: string): Promise<TaskList>
  • 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

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

    Returns Promise<TaskList>

getAllSpecifications

  • getAllSpecifications(groupAlias: string, oDataQueryString?: string): Promise<SpecificationData[]>
  • 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.

    • Default value oDataQueryString: string = ""

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

    Returns Promise<SpecificationData[]>

getAllSpecificationsByProjectName

  • getAllSpecificationsByProjectName(groupAlias: string, projectName: string): Promise<SpecificationData[]>
  • 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[]>

getAllSpecificationsByStateName

  • getAllSpecificationsByStateName(groupAlias: string, stateName: string): Promise<SpecificationData[]>
  • 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[]>

getAllSpecificationsCreatedBetween

  • getAllSpecificationsCreatedBetween(groupAlias: string, startDate: string, endDate: string): Promise<SpecificationData[]>
  • 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[]>

getAllSpecificationsEditedBetween

  • getAllSpecificationsEditedBetween(groupAlias: string, startDate: string, endDate: string): Promise<SpecificationData[]>
  • 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[]>

getProject

  • getProject(groupAlias: string, projectId: string): Promise<ProjectData>
  • 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>

getProjects

  • getProjects(groupAlias: string): Promise<ProjectData[]>
  • 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.

    Returns Promise<ProjectData[]>

getSpecification

  • getSpecification(groupAlias: string, specificationId: string): Promise<Specification>
  • 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

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

    Returns Promise<Specification>

getSpecificationActions

  • getSpecificationActions(groupAlias: string, specificationId: string): Promise<ActionData[]>
  • 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

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

    Returns Promise<ActionData[]>

getSpecificationById

  • getSpecificationById(groupAlias: string, specificationId: string): Promise<SpecificationData>
  • 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

      The unique identifier of the specification to retrieve.

    Returns Promise<SpecificationData>

getSpecificationByName

  • getSpecificationByName(groupAlias: string, specificationName: string): Promise<SpecificationData>
  • 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.

    Returns Promise<SpecificationData>

getSpecificationConstantByName

  • getSpecificationConstantByName(groupAlias: string, specificationId: string, constantName: string): Promise<ConstantData>
  • 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

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

    • constantName: string

      The name of the constant to retrieve.

    Returns Promise<ConstantData>

getSpecificationConstants

  • getSpecificationConstants(groupAlias: string, specificationId: string): Promise<ConstantData[]>
  • Gets all constants for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the constants to retrieve.

    • specificationId: string

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

    Returns Promise<ConstantData[]>

getSpecificationDocumentById

  • getSpecificationDocumentById(groupAlias: string, specificationId: string, documentId: string): Promise<DocumentData>
  • Gets the document with the provided identifier.

    Parameters

    • groupAlias: string

      The alias of the group containing the document to retrieve.

    • specificationId: string

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

    • documentId: string

      The identifier of the document to retrieve.

    Returns Promise<DocumentData>

getSpecificationDocumentUrl

  • getSpecificationDocumentUrl(groupAlias: string, specificationId: string, documentId: string, resourceName: string): string
  • Gets the download url of a specified document.

    Parameters

    • groupAlias: string

      The alias of the group containing the document.

    • specificationId: string

      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

getSpecificationDocuments

  • getSpecificationDocuments(groupAlias: string, specificationId: string): Promise<DocumentData[]>
  • Gets all documents for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the documents to retrieve.

    • specificationId: string

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

    Returns Promise<DocumentData[]>

getSpecificationFormData

  • getSpecificationFormData(groupAlias: string, specificationId: string, versionId?: string): Promise<FormData>
  • Gets a specification's active form data.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

getSpecificationOperationByName

  • getSpecificationOperationByName(groupAlias: string, specificationId: string, operationName: string): Promise<ActionData>
  • Gets information about the chosen operation for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the operation to retrieve.

    • specificationId: string

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

    • operationName: string

      The name of the operation to retrieve.

    Returns Promise<ActionData>

getSpecificationProperties

  • getSpecificationProperties(groupAlias: string, specificationId: string): Promise<object>
  • Gets the specification properties for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification properties.

    • specificationId: string

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

    Returns Promise<object>

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

getSpecificationReportById

  • getSpecificationReportById(groupAlias: string, specificationId: string, reportId: string): Promise<ReportData>
  • Gets the specification report with the provided identifier.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification report.

    • specificationId: string

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

    • reportId: string

      The identifier of the report to retrieve.

    Returns Promise<ReportData>

getSpecificationReportJson

  • getSpecificationReportJson(groupAlias: string, specificationId: string, reportId: string): Promise<ReportJsonData>
  • Gets the chosen specification report in JSON format.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification report.

    • specificationId: string

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

    • reportId: string

      The identifier of the report to retrieve.

    Returns Promise<ReportJsonData>

getSpecificationReportUrl

  • getSpecificationReportUrl(groupAlias: string, specificationId: string, reportId: string): string
  • Gets the download url for the chosen specification report.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification report.

    • specificationId: string

      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

getSpecificationReports

  • getSpecificationReports(groupAlias: string, specificationId: string): Promise<ReportData[]>
  • Gets all specification reports for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the specification reports.

    • specificationId: string

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

    Returns Promise<ReportData[]>

getSpecificationTransitionByName

  • getSpecificationTransitionByName(groupAlias: string, specificationId: string, transitionName: string): Promise<TransitionData>
  • Gets information about the chosen transition for a specification.

    Parameters

    • groupAlias: string

      The alias of the group containing the transition to retrieve.

    • specificationId: string

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

    • transitionName: string

      The name of the transition to retrieve.

    Returns Promise<TransitionData>

getSpecificationVariableByName

  • getSpecificationVariableByName(groupAlias: string, specificationId: string, variableName: string): Promise<VariableData>
  • 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

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

    • variableName: string

      The name of the variable to retrieve.

    Returns Promise<VariableData>

getSpecificationVariables

  • getSpecificationVariables(groupAlias: string, specificationId: string): Promise<VariableData[]>
  • Gets all variables for a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the variables belong to.

    • specificationId: string

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

    Returns Promise<VariableData[]>

invokeChildSpecificationOperation

  • invokeChildSpecificationOperation(groupAlias: string, specificationId: string, childSpecificationListControlName: string, operationName: string, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

invokeChildSpecificationTransition

  • invokeChildSpecificationTransition(groupAlias: string, specificationId: string, childSpecificationListControlName: string, transitionName: string, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

invokeDialogCancel

  • invokeDialogCancel(groupAlias: string, specificationId: string, versionId?: string): Promise<FormData>
  • Cancels the active dialog and closes it. The latest FormData will be returned.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

invokeDialogOk

  • invokeDialogOk(groupAlias: string, specificationId: string, versionId?: string): Promise<FormData>
  • Confirms the chosen items on a dialog and closes it. The latest FormData will be returned.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

invokeOperation

  • invokeOperation(groupAlias: string, specificationId: string, operationName: string): Promise<any>
  • Invokes an operation on a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • operationName: string

      The name of the operation to invoke.

    Returns Promise<any>

invokeTransition

  • invokeTransition(groupAlias: string, specificationId: string, transitionName: string): Promise<any>
  • Invokes a transition on a specification.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • transitionName: string

      The name of the transition to invoke.

    Returns Promise<any>

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>

logoutAllGroups

  • logoutAllGroups(): Promise<number>
  • Logs out of all groups in the session that are currently logged in.

    Returns Promise<number>

logoutGroup

  • logoutGroup(groupAlias: string): Promise<number>
  • Logs out of the current session of the group.

    Parameters

    • groupAlias: string

      The alias of the group to log out of.

    Returns Promise<number>

moveChildSpecificationListItem

  • moveChildSpecificationListItem(groupAlias: string, specificationId: string, childSpecificationListControlName: string, commandData: MoveListItemCommandData, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

moveItemListItem

  • moveItemListItem(groupAlias: string, specificationId: string, itemListControlName: string, commandData: MoveListItemCommandData, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

navigateHyperlink

  • navigateHyperlink(groupAlias: string, specificationId: string, hyperlinkControlName: string, versionId?: string): Promise<FormData>
  • Navigates to the hyperlink of a Hyperlink control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • hyperlinkControlName: string

      The name of the Hyperlink control.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

navigateSpecification

  • navigateSpecification(groupAlias: string, specificationId: string, direction: "backward" | "forward"): Promise<FormData>
  • Navigates a specification in the chosen direction.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

      The unique identifier of the specification to navigate.

    • direction: "backward" | "forward"

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

    Returns Promise<FormData>

openDialog

  • openDialog(groupAlias: string, specificationId: string, dialogButtonControlName: string, versionId?: string): Promise<FormData>
  • Opens the dialog of a Dialog Button.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • dialogButtonControlName: string

      The name of the Dialog Button control.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

removeChildSpecificationListItem

  • removeChildSpecificationListItem(groupAlias: string, specificationId: string, childSpecificationListControlName: string, versionId?: string): Promise<FormData>
  • 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

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

    • childSpecificationListControlName: string

      The name of the Child Specification List control.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

requestPreview

  • requestPreview(groupAlias: string, specificationId: string, previewControlName: string, versionId?: string): Promise<FormData>
  • Requests a preview from a 3D Preview control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • previewControlName: string

      The name of the 3D Preview control.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

requestScreenshot

  • requestScreenshot(groupAlias: string, specificationId: string, previewControlName: string, commandData: RequestPreviewScreenshotCommandData, versionId?: string): Promise<FormData>
  • Requests a screenshot from a 3D Preview control.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • previewControlName: string

      The name of the 3D Preview control.

    • commandData: RequestPreviewScreenshotCommandData

      The RequestPreviewScreenshotCommandData containing data to specify the screenshot.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

runControlMacro

  • runControlMacro(groupAlias: string, specificationId: string, controlName: string, macroData: ControlMacroData, versionId?: string): Promise<FormData>
  • Runs a macro for a specification control and returns the latest FormData.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

runMacro

  • runMacro(groupAlias: string, specificationId: string, macroData: SpecificationMacroData, versionId?: string): Promise<void>
  • Runs a macro for a specification and returns the latest FormData.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<void>

    A Promise that will complete when the macro has been ran.

runTouchPointMacro

  • runTouchPointMacro(groupAlias: string, specificationId: string, previewControlName: string, commandData: TouchPointCommandData, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

setChildSpecificationListSelectedIndex

  • setChildSpecificationListSelectedIndex(groupAlias: string, specificationId: string, childSpecificationListControlName: string, index: number, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

setFormContainerSize

  • setFormContainerSize(groupAlias: string, specificationId: string, height: number, width: number, force?: boolean, versionId?: string): Promise<FormData>
  • Sets the form container size of a specification and returns the latest FormData.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

      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.

    • Default value force: boolean = true

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

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

setHostedSpecificationFormContainerSize

  • setHostedSpecificationFormContainerSize(groupAlias: string, specificationId: string, height: number, width: number, force?: boolean, specificationHostControlName: string, versionId?: string): Promise<FormData>
  • Sets the form container size of a hosted specification and returns the latest FormData.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

      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.

    • Default value 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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

setItemListSelectedIndex

  • setItemListSelectedIndex(groupAlias: string, specificationId: string, listControlName: string, rowIndex: number, versionId?: string): Promise<FormData>
  • 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

      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.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

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>

updateConstantValue

  • updateConstantValue(groupAlias: string, specificationId: string, constantName: string, constantValue: string): Promise<ConstantData>
  • Updates a constant with the provided value.

    Parameters

    • groupAlias: string

      The alias of the group that the constant belongs to.

    • specificationId: string

      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>

updateControlProperty

  • updateControlProperty(groupAlias: string, specificationId: string, controlName: string, propertyName: string, propertyValue: string, versionId?: string): Promise<FormData>
  • Updates a control's property and returns the latest FormData.

    Parameters

    • groupAlias: string

      The alias of the group that the specification belongs to.

    • specificationId: string

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

    • controlName: string

      The name of the control that the property belongs to.

    • propertyName: string

      The name of the property to update.

    • propertyValue: string

      The value to update the property with.

    • Optional versionId: string

      The optional unique identifier of a specification form version used to calculate a differenced FormData result.

    Returns Promise<FormData>

    The provided versionId will be used to calculate a differenced FormData result between the supplied and latest version. If no versionId is provided, a complete FormData result will be returned. A version identifier can be retrieved from any FormData object.

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>