Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CatavoltApi

Hierarchy

  • CatavoltApi

Implemented by

Index

Properties

DEFAULT_LOCALE

DEFAULT_LOCALE: CvLocale

clientTimeoutMillis

clientTimeoutMillis: number

currencySymbol

currencySymbol: string

dataLastChangedTime

dataLastChangedTime: Date

deviceProps

deviceProps: object

Type declaration

  • [p: string]: string

dialogApi

dialogApi: DialogApi

isLoggedIn

isLoggedIn: boolean

locale

locale: CvLocale

remainingSessionTime

remainingSessionTime: number

session

session: Session

sessionHasExpired

sessionHasExpired: boolean

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>
  • Parameters

    • tenantId: string
    • clientType: ClientType
    • userId: string
    • existingPassword: string
    • newPassword: string

    Returns Promise<Session | Redirection>

getRedirection

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

    • redirectionId: string

    Returns Promise<Redirection>

initDialogApi

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

    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

login

  • Log in and retrieve the Session

    Parameters

    • tenantId: string
    • clientType: ClientType
    • userId: string
    • password: string

    Returns Promise<Session | Redirection>

logout

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

    Returns Promise<object>

openDialog

openDialogWithId

  • openDialogWithId(dialogId: string): Promise<Dialog>
  • Parameters

    • dialogId: string

    Returns Promise<Dialog>

openStream

  • Parameters

    • url: string

    Returns Promise<StreamProducer>

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 CatavoltApiImpl

    Parameters

    • tenantId: string
    • sessionId: string

    Returns Promise<Session>

streamContent

toDialogOrRedirection

  • Parameters

    • resultPr: Promise<__type>

    Returns Promise<Dialog | Redirection>

Generated using TypeDoc