Interface ExtensionAPI

The API for operations related to the Trimble Connect web plug-ins.

Hierarchy

ExtensionAPI

Index

Properties

host

Methods

Properties

Optional host

host?: { name: string }

Host metadata

Type declaration

name: string

An UI friendly display name

Methods

broadcast

broadcast(message: any): Promise<boolean>

Broadcasts a message to other plug-ins.

Parameters
- message: any
  
  The message to be broadcast
Returns Promise<boolean>
The awaitable task

configure

configure(config: ExtensionSource): Promise<boolean>

Configures the Extension.

Parameters
- config: ExtensionSource
  
  The plug-in configuration
Returns Promise<boolean>
The awaitable task

getPermission

getPermission(permission: "accesstoken"): Promise<string>

Configures the Trimble Connect project extension.

deprecated
Use ExtensionAPI.requestPermission instead.

Parameters
- permission: "accesstoken"
  
  type of the permssion. For now only accesstoken is available.
Returns Promise<string>
The awaitable task

getStatusMessage

getStatusMessage(): Promise<string>

Get the current status message of the Trimble Connect project extension.

deprecated
Will be removed in the future release.

Returns Promise<string>
The awaitable task

goTo

goTo(routeKey: IRouteKey, params?: Viewer3DEmbedProperties): Promise<boolean>

Go to a specific route/page from the Trimble Connect project extension.

Parameters
- routeKey: IRouteKey
- Optional params: Viewer3DEmbedProperties
Returns Promise<boolean>
The awaitable task

goToSettings

goToSettings(): Promise<boolean>

Go to the extension settings page from the Trimble Connect project extension.

deprecated
Use ExtensionAPI.goTo instead.

Returns Promise<boolean>
The awaitable task

requestFocus

requestFocus(): Promise<boolean>

Returns Promise<boolean>

requestPermission

requestPermission(permission: "accesstoken"): Promise<string>

Requests permission to get the accessToken from the application.

Parameters
- permission: "accesstoken"
Returns Promise<string>
The status for requested permission.

setStatusMessage

setStatusMessage(message: string): Promise<boolean>

Set the extension status.

Parameters
- message: string
  
  The extension status message of the Trimble Connect project extension.
Returns Promise<boolean>
The awaitable task