Constructors

Properties

_isOnline: null | boolean = null
addAccessTokenRefreshListener: ((handler) => (() => void)) = addAccessTokenRefreshListener

Type declaration

    • (handler): (() => void)
    • Parameters

      • handler: ((token) => void)
          • (token): void
          • Parameters

            • token: string

            Returns void

      Returns (() => void)

        • (): void
        • Returns void

addChannelDataListener: ((channel, handler) => (() => void)) = addChannelDataListener

Type declaration

    • (channel, handler): (() => void)
    • Parameters

      • channel: string
      • handler: ((e) => void)
          • (e): void
          • Parameters

            • e: {
                  data: any;
                  source: string;
              }
              • data: any
              • source: string

            Returns void

      Returns (() => void)

        • (): void
        • Returns void

addMenuListener: ((handler) => (() => void)) = addMenuListener

Type declaration

    • (handler): (() => void)
    • Parameters

      • handler: ((label) => void)
          • (label): void
          • Parameters

            • label: string

            Returns void

      Returns (() => void)

        • (): void
        • Returns void

addModuleConfigurationListener: ((handler) => (() => void)) = addModuleConfigurationListener

Type declaration

    • (handler): (() => void)
    • Parameters

      Returns (() => void)

        • (): void
        • Returns void

addModuleDataListener: ((handler) => (() => void)) = addModuleDataListener

Type declaration

    • (handler): (() => void)
    • Parameters

      • handler: ((data) => void)
          • (data): void
          • Parameters

            Returns void

      Returns (() => void)

        • (): void
        • Returns void

addOverviewDeviceListener: ((handler) => (() => void)) = addOverviewDeviceListener

Type declaration

    • (handler): (() => void)
    • Parameters

      • handler: ((devices) => void)
          • (devices): void
          • Parameters

            Returns void

      Returns (() => void)

        • (): void
        • Returns void

addStreamListener: ((streamNames, streamTypes, handler) => (() => void)) = addStreamListener

Type declaration

    • (streamNames, streamTypes, handler): (() => void)
    • Parameters

      • streamNames: string[]
      • streamTypes: (keyof IStreamTypeMap)[]
      • handler: ((response) => void)

      Returns (() => void)

        • (): void
        • Returns void

disableAnalyticsBottomBar: (() => void) = disableAnalyticsBottomBar

Type declaration

    • (): void
    • Returns void

getCurrentModuleContext: (() => string | null) = getCurrentModuleContext

Type declaration

    • (): string | null
    • Returns string | null

getDate: ((time?, minTime?, maxTime?) => Promise<unknown>) = getDate

Type declaration

    • (time?, minTime?, maxTime?): Promise<unknown>
    • Parameters

      • Optional time: Date
      • Optional minTime: Date
      • Optional maxTime: Date

      Returns Promise<unknown>

goToDevice: ((deviceId) => void) = goToDevice

Type declaration

    • (deviceId): void
    • Parameters

      • deviceId: string

      Returns void

goToTime: ((date) => void) = goToTime

Type declaration

    • (date): void
    • Parameters

      • date: Date

      Returns void

prompt: ((schema, options?) => Promise<any>) = prompt

Type declaration

    • (schema, options?): Promise<any>
    • Parameters

      • schema: JsonSchema
      • Optional options: {
            cancelText?: string;
            okText?: string;
        }
        • Optional cancelText?: string
        • Optional okText?: string

      Returns Promise<any>

refreshAuthToken: (() => void) = refreshAuthToken

Type declaration

    • (): void
    • Returns void

requestModuleData: (() => void) = requestModuleData

Type declaration

    • (): void
    • Returns void

sendChannelData: ((channel, data) => void) = sendChannelData

Type declaration

    • (channel, data): void
    • Parameters

      • channel: string
      • data: any

      Returns void

setModuleDateTimeRange: ((beforeInMilliseconds, afterInMilliseconds?) => void) = setModuleDateTimeRange

Type declaration

    • (beforeInMilliseconds, afterInMilliseconds?): void
    • Parameters

      • beforeInMilliseconds: number
      • Optional afterInMilliseconds: number

      Returns void

setupModuleMenus: ((menus) => void) = setupModuleMenus

Type declaration

    • (menus): void
    • Parameters

      • menus: {
            label: string;
        }[]

      Returns void

showMessage: ((message) => void) = showMessage

Type declaration

    • (message): void
    • Parameters

      • message: string

      Returns void

Accessors

Methods

  • Parameters

    • deadlineMs: number = 1_000

    Returns Promise<boolean>

  • Returns Promise<undefined | string>

  • Returns (() => void)

      • (): void
      • Returns void

  • Parameters

    • deadlineMs: number = 5_000

    Returns Promise<void>

Generated using TypeDoc