Class CoreClient

Hierarchy

CoreClient

Implements

HasEventHandling

Constructors

constructor

new CoreClient(serverUrl, connectOptions?): CoreClient
Parameters
- serverUrl: string
- Optional connectOptions: ConnectOptions
Returns CoreClient

Properties

`Static` `Readonly` EVENT_CONNECT

EVENT_CONNECT: string

`Static` `Readonly` EVENT_DISCONNECT

EVENT_DISCONNECT: string

`Static` `Readonly` EVENT_RECONNECT

EVENT_RECONNECT: string

`Static` `Readonly` EVENT_RECONNECT_AUTH_FAILED

EVENT_RECONNECT_AUTH_FAILED: string

`Static` `Readonly` EVENT_REFRESH_TOKEN_UPDATED

EVENT_REFRESH_TOKEN_UPDATED: string

Deprecated

`Static` `Readonly` EVENT_REQUEST_FAILED

EVENT_REQUEST_FAILED: string

`Static` `Readonly` EVENT_REQUEST_STARTED

EVENT_REQUEST_STARTED: string

`Static` `Readonly` EVENT_REQUEST_SUCCEEDED

EVENT_REQUEST_SUCCEEDED: string

`Static` `Readonly` LOGIN_TYPE_ANONYMOUS

LOGIN_TYPE_ANONYMOUS: string

`Static` `Readonly` LOGIN_TYPE_PASSWORD

LOGIN_TYPE_PASSWORD: string

Methods

addEventListener

addEventListener<T>(name, callback): (() => void)
Type Parameters
- T
Parameters
- name: string
- callback: ((e) => void)
  - - (e): void
    - Parameters
      
      e: Event<T>
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void

disconnect

disconnect(): void
Returns void

getAsIdeConnection

getAsIdeConnection(): Promise<IdeConnection>
Returns Promise<IdeConnection>

getAuthConfigValues

getAuthConfigValues(): Promise<string[][]>
Returns Promise<string[][]>

getServerConfigValues

getServerConfigValues(): Promise<string[][]>
Returns Promise<string[][]>

getServerUrl

getServerUrl(): string
Returns string

getStorageService

getStorageService(): StorageService
Returns StorageService

hasListeners

hasListeners(name): boolean
Parameters
- name: string
Returns boolean

login

login(credentials): Promise<void>
Parameters
- credentials: LoginCredentials
Returns Promise<void>

nextEvent

nextEvent<T>(eventName, timeoutInMillis?): Promise<any>
Type Parameters
- T
Parameters
- eventName: string
- Optional timeoutInMillis: number
Returns Promise<any>

onConnected

onConnected(timeoutInMillis?): Promise<void>
Parameters
- Optional timeoutInMillis: number
Returns Promise<void>

relogin

relogin(token): Promise<void>
Parameters
- token: RefreshToken
Returns Promise<void>

removeEventListener

removeEventListener<T>(name, callback): boolean
Type Parameters
- T
Parameters
- name: string
- callback: ((e) => void)
  - - (e): void
    - Parameters
      
      e: Event<T>
      
      Returns void
Returns boolean

running

running(): Promise<CoreClient>
Returns Promise<CoreClient>