Interface Integration

devices

workspaces

xapi

decodeJwt

• decodeJwt(jwt): DataObject

• Helper function for decoding a JSON Web Token. Throws error if not valid.

  Parameters

  • jwt: string

    B64-encoded JWT string, as received from Webex

  Returns DataObject

getAppInfo

• getAppInfo(): Promise<AppInfo>

• Returns Promise<AppInfo>

onAction

• onAction(handler): any

• Sets an action handler, so you are notified when there are important action notifications such as if the integration manifest was updated.

  Parameters

  • handler: ActionHandler

  Returns any

onError

• onError(handler): any

• Sets an error handler on the integration, so you are notified when something goes wrong. This will typically be called if the SDK is not able to refresh the access token eg due to network issues or if Webex is not available.

  Parameters

  • handler: ErrorHandler

  Returns any

ping

• ping(): Promise<any>

• Checks the state of the integration. Checks that it's able to talk to Webex, implying that the access token is valid etc.

  Returns Promise<any>

  Promise containing the http response from Webex

processNotifications

• processNotifications(notifications): any

• Takes a list of events from Webex and checks if you have event listeners registered that match the incoming notification, and if so deliver it.

  Parameters

  • notifications: DataObject[]

    The payload (list of messages) from an incoming Webex web hook

  Returns any

refreshToken

• refreshToken(): void

• Returns void

webexApi

• webexApi(partialUrl, method?, body?, contentType?): Promise<any>

• Parameters

  • partialUrl: string

  • Optional method: string

  • Optional body: any

  • Optional contentType: string

  Returns Promise<any>