Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CatavoltApi

Top-level entry point into the Catavolt API

Hierarchy

  • CatavoltApi

Index

Constructors

Private constructor

  • new CatavoltApi(serverUrl: string, serverVersion: string): CatavoltApi
  • Construct an CatavoltApi This should not be called directly, instead use the 'singleton' method

    Parameters

    • serverUrl: string
    • serverVersion: string

    Returns CatavoltApi

Properties

Private _clientMode

_clientMode: ClientMode = ClientMode.ONLINE

Private _devicePropsDynamic

_devicePropsDynamic: object

Type declaration

  • [index: string]: function
      • (): string
      • Returns string

Private _devicePropsStatic

_devicePropsStatic: object

Type declaration

  • [index: string]: string

Private _dialogApi

_dialogApi: DialogApi

Private _session

_session: Session

dataLastChangedTime

dataLastChangedTime: Date = new Date(0)

Static Private ONE_HOUR_IN_MILLIS

ONE_HOUR_IN_MILLIS: number = 60 * 60 * 1000

Static Private SERVER_URL

SERVER_URL: string = "https://dialog.hxgn-api.net"

Static Private SERVER_VERSION

SERVER_VERSION: string = "v0"

Static Private _singleton

_singleton: CatavoltApi

Accessors

browserLocaleJson

  • get browserLocaleJson(): string
  • Get the json representation of this client's locale. The server pulls this value from the agent string and returns it to the client.

    Returns string

clientTimeoutMillis

  • get clientTimeoutMillis(): number
  • Get the number of millis that the client will remain active between calls to the server.

    Returns number

currencySymbol

  • get currencySymbol(): string
  • Get the currency symbol override if defined from the server.

    Returns string

deviceProps

  • get deviceProps(): object
  • Get the device props

    Returns object

    • [index: string]: string

dialogApi

isLoggedIn

  • get isLoggedIn(): boolean
  • Checked logged in status

    Returns boolean

remainingSessionTime

  • get remainingSessionTime(): number
  • Time remaining before this session is expired by the server

    Returns number

session

sessionHasExpired

  • get sessionHasExpired(): boolean
  • Return whether or not the session has expired

    Returns boolean

Static defaultTTLInMillis

  • get defaultTTLInMillis(): number
  • Get the default session time

    Returns number

Static singleton

Methods

addDynamicDeviceProp

  • addDynamicDeviceProp(propName: string, propFn: function): void
  • Add or replace a dynamic device property (func)

    Parameters

    • propName: string
    • propFn: function
        • (): string
        • Returns string

    Returns void

addStaticDeviceProp

  • addStaticDeviceProp(propName: string, propValue: string): void
  • Add or replace a static device property

    Parameters

    • propName: string
    • propValue: string

    Returns void

changePasswordAndLogin

  • changePasswordAndLogin(tenantId: string, clientType: ClientType, userId: string, existingPassword: string, newPassword: string): Promise<Session | Redirection>

getRedirection

  • getRedirection(redirectionId: string): Promise<Redirection>

getWorkbench

  • getWorkbench(workbenchId: string): Promise<Workbench>
  • Get a Workbench by workbenchId

    Parameters

    • workbenchId: string

    Returns Promise<Workbench>

getWorkbenches

  • getWorkbenches(): Promise<Array<Workbench>>

initDialogApi

  • initDialogApi(serverUrl: string, serverVersion?: string): void
  • Initialize a dialog service implementation for use by this CatavoltApi

    Parameters

    • serverUrl: string
    • Default value serverVersion: string = CatavoltApi.SERVER_VERSION

    Returns void

initPersistentApi

  • initPersistentApi(serverUrl: string, serverVersion: string): void
  • Initialize an offline dialog service

    Parameters

    • serverUrl: string
    • serverVersion: string

    Returns void

isFeatureSetAvailable

  • isFeatureSetAvailable(featureSet: FeatureSet): boolean
  • Check for the availability of the given featureSet

    see

    FeatureSet

    Parameters

    Returns boolean

isOfflineMode

  • isOfflineMode(): boolean

isPersistentClient

  • isPersistentClient(): boolean

login

logout

  • logout(): Promise<object>
  • Logout and destroy the session

    Returns Promise<object>

openDialog

performWorkbenchAction

performWorkbenchActionForId

  • performWorkbenchActionForId(workbenchId: string, workbenchActionId: string): Promise<object | Redirection>
  • Open a {@link WorkbenchWorkbenchAction}

    Parameters

    • workbenchId: string
    • workbenchActionId: string

    Returns Promise<object | Redirection>

    | Redirection>}

refreshSession

  • refreshSession(tenantId: string, sessionId: string): Promise<Session>
  • Refresh the CatavoltApi

    Parameters

    • tenantId: string
    • sessionId: string

    Returns Promise<Session>

setOfflineMode

  • setOfflineMode(): void

setOnlineClient

  • setOnlineClient(): void

setOnlineMode

  • setOnlineMode(): void

setPersistentClient

  • setPersistentClient(): void

toDialogOrRedirection

Generated using TypeDoc