Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExtensionAPI

The API for operations related to the Trimble Connect Web Extensions.

Hierarchy

  • ExtensionAPI

Index

Methods

Methods

getPermission

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

  • Configures the Extension.

    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 extension

    Returns Promise<string>

    The awaitable task

goTo

  • goTo(routeKey: IRouteKey): Promise<boolean>

  • Go to the extension settings page

    Parameters

    Returns Promise<boolean>

    The awaitable task

goToSettings

  • goToSettings(): Promise<boolean>

  • Go to the extension settings page

    Returns Promise<boolean>

    The awaitable task

setStatusMessage

  • setStatusMessage(message: string): Promise<boolean>

  • Set the extension status.

    Parameters

    • message: string

      The extension status message

    Returns Promise<boolean>

    The awaitable task

Generated using TypeDoc