Project trimble-connect-project-workspace-api

connect

• connect(target: Window | HTMLIFrameElement, onEvent?: (event: ExtensionEvents, arg: { data: any }) => void, timeout?: number): Promise<TCExtensionAPI>

• Connects to the Trimble Connect Web application.

  Parameters

  • target: Window | HTMLIFrameElement

    The target dispatcher or the iframe hosting the Trimble Connect Web application.

  • Optional onEvent: (event: ExtensionEvents, arg: { data: any }) => void

    The callback that receives the events dispatched from the Trimble Connect Web application.

    • • (event: ExtensionEvents, arg: { data: any }): void

      • Parameters

        • event: ExtensionEvents

        • arg: { data: any }

          • data: any

        Returns void

  • Optional timeout: number

    The optional timeout in milliseconds. If not specified default timeout is 10000ms

  Returns Promise<TCExtensionAPI>

  A promise that resolves to the set of exposed external API from the Trimble Connect Web application. Use the exposed API to communicate with the Trimble Connect Web application.