Class CoreClient

constructor

• new CoreClient(serverUrl, connectOptions?): CoreClient

• Parameters

  • serverUrl: string

  • Optional connectOptions: ConnectOptions

  Returns CoreClient

Static Readonly EVENT_CONNECT

Static Readonly EVENT_DISCONNECT

Static Readonly EVENT_RECONNECT

Static Readonly EVENT_RECONNECT_AUTH_FAILED

Static Readonly EVENT_REFRESH_TOKEN_UPDATED

Static Readonly EVENT_REQUEST_FAILED

Static Readonly EVENT_REQUEST_STARTED

Static Readonly EVENT_REQUEST_SUCCEEDED

Static Optional Readonly FEATURES

Static Readonly LOGIN_TYPE_ANONYMOUS

Static Readonly LOGIN_TYPE_PASSWORD

addEventListener

• addEventListener<T>(name, callback): (() => void)

• Listen for events on this object.

  Type Parameters

  • T

    The type of the data that the event will provide.

  Parameters

  • name: string

    The name of the event to listen for.

  • callback: ((e) => void)

    A function to call when the event occurs.

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Returns void

disconnect

• disconnect(): void

• Disconnects and releases resources associated with this client.

  Returns void

getAsIdeConnection

• getAsIdeConnection(): Promise<IdeConnection>

• Returns a promise that resolves to the underlying IdeConnection.

  Returns Promise<IdeConnection>

getAuthConfigValues

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

• Fetches authentication configuration values.

  This method is intended to be used before a session is established.

  Returns Promise<string[][]>

  a promise of key/value pairs, returned as a two-element string array per entry

getServerConfigValues

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

• Fetches server configuration values for the current connection.

  Returns Promise<string[][]>

  a promise of configuration entries as an array of [key, value] string pairs

getServerUrl

• getServerUrl(): string

• Returns the server URL associated with this client.

  Returns string

getStorageService

• getStorageService(): StorageService

• Returns a storage service associated with this client's connection.

  Returns StorageService

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

login

• login(credentials): Promise<void>

• Logs in using the provided credentials.

  Parameters

  • credentials: LoginCredentials

    the login credentials

  Returns Promise<void>

  a promise which resolves once the client has connected using the provided credentials

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<Event<T>>

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<Event<T>>

onConnected

• onConnected(timeoutInMillis?): Promise<void>

• Resolves when the client is connected.

  Parameters

  • Optional timeoutInMillis: number

    ignored, only exists for legacy callers

  Returns Promise<void>

  a promise that resolves when connection is established, or rejects if connection fails

relogin

• relogin(token): Promise<void>

• Logs in using a refresh token.

  Parameters

  • token: RefreshToken

    the refresh token

  Returns Promise<void>

  a promise which resolves once the client has connected using the updated credentials

removeEventListener

• removeEventListener<T>(name, callback): boolean

• Removes an event listener added to this table.

  Type Parameters

  • T

  Parameters

  • name: string

  • callback: ((e) => void)

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns boolean

running

• running(): Promise<CoreClient>

• Indicates whether this client instance is still usable.

  Returns Promise<CoreClient>

  a promise which resolves to this when the client is usable