Class ApiClient

Hierarchy (View Summary)

TypedEventEmitter<ApiClientEvents>
- ApiClient

Index

Constructors

constructor

new ApiClient(__namedParameters: ApiClientOptions): ApiClient
Parameters
- __namedParameters: ApiClientOptions
Returns ApiClient
Overrides TypedEventEmitter.constructor
- Defined in ApiClient/index.ts:83

Properties

`Readonly`appId

appId: string

`Optional` `Readonly`appSource

appSource?: string

`Readonly`attribution

attribution: Readonly<
    {
        connection?: Readonly<Partial<ConnectionAttribution>>;
        workload?: Readonly<WorkloadAttributionDefaults>;
    },
>

`Protected`listeners

listeners: {
    connected?: (data: { network: SupernetType }) => void[];
    connecting?: (data: { network: SupernetType }) => void[];
    disconnected?: (data: { code: ErrorCode; reason: string }) => void[];
} = {}

Type declaration

Optionalconnected?: (data: { network: SupernetType }) => void[]
ApiClient#connected - The client has been connected to the server.
Optionalconnecting?: (data: { network: SupernetType }) => void[]
ApiClient#connecting - The client is attempting to connect to the server.
Optionaldisconnected?: (data: { code: ErrorCode; reason: string }) => void[]
ApiClient#disconnected - The client has been disconnected by the server, either authentication is lost or the server is unreachable.This event is not triggered when the client manually disconnects.

`Readonly`logger

logger: Logger

Accessors

auth

get auth(): AuthManager
Returns AuthManager
- Defined in ApiClient/index.ts:148

isAuthenticated

get isAuthenticated(): boolean
Returns boolean
- Defined in ApiClient/index.ts:144

rest

get rest(): RestClient
Returns RestClient
- Defined in ApiClient/index.ts:156

socket

get socket(): IWebSocketClient
Returns IWebSocketClient
- Defined in ApiClient/index.ts:152

socketEnabled

get socketEnabled(): boolean
Returns boolean
- Defined in ApiClient/index.ts:160

Methods

attributionHeaders

attributionHeaders(
    appSource: undefined | string,
    override?: WorkloadAttributionInput,
    fallbackOperationId?: string,
): Record<string, string>
Parameters
- appSource: undefined | string
- Optionaloverride: WorkloadAttributionInput
- OptionalfallbackOperationId: string
Returns Record<string, string>
- Defined in ApiClient/index.ts:168

dispose

dispose(): void
Dispose of this client, disconnecting the socket and removing all event listeners. After calling this method, the client should not be used.

Returns void
- Defined in ApiClient/index.ts:260

`Protected`emit

emit<T extends keyof ApiClientEvents>(event: T, data: ApiClientEvents[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends keyof ApiClientEvents
Parameters
- event: T
- data: ApiClientEvents[T]
Returns void
Inherited from TypedEventEmitter.emit
- Defined in lib/TypedEventEmitter.ts:69

handleAuthUpdated

handleAuthUpdated(isAuthenticated: boolean): void
Parameters
- isAuthenticated: boolean
Returns void
- Defined in ApiClient/index.ts:245

handleSocketConnect

handleSocketConnect(__namedParameters: ServerConnectData): void
Parameters
- __namedParameters: ServerConnectData
Returns void
- Defined in ApiClient/index.ts:188

handleSocketConnecting

handleSocketConnecting(): void
Returns void
- Defined in ApiClient/index.ts:184

handleSocketDisconnect

handleSocketDisconnect(data: ServerDisconnectData): void
Parameters
- data: ServerDisconnectData
Returns void
- Defined in ApiClient/index.ts:193

off

off<T extends keyof ApiClientEvents>(
event: T,
listener: (data: ApiClientEvents[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends keyof ApiClientEvents
Parameters
- event: T
- listener: (data: ApiClientEvents[T]) => void
Returns void
Inherited from TypedEventEmitter.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends keyof ApiClientEvents>(
event: T,
listener: (data: ApiClientEvents[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends keyof ApiClientEvents
Parameters
- event: T
- listener: (data: ApiClientEvents[T]) => void
Returns () => void
Inherited from TypedEventEmitter.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends keyof ApiClientEvents>(
event: T,
listener: (data: ApiClientEvents[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends keyof ApiClientEvents
Parameters
- event: T
- listener: (data: ApiClientEvents[T]) => void
Returns () => void
Inherited from TypedEventEmitter.once
- Defined in lib/TypedEventEmitter.ts:32

removeAllListeners

removeAllListeners<T extends keyof ApiClientEvents>(event?: T): void
Remove all event listeners, optionally for a specific event
Type Parameters
- T extends keyof ApiClientEvents
Parameters
- Optionalevent: T
Returns void
Inherited from TypedEventEmitter.removeAllListeners
- Defined in lib/TypedEventEmitter.ts:56

resolveWorkloadAttribution

resolveWorkloadAttribution(
override?: WorkloadAttributionInput,
fallbackOperationId?: string,
): undefined | WorkloadAttributionInput
Parameters
- Optionaloverride: WorkloadAttributionInput
- OptionalfallbackOperationId: string
Returns undefined | WorkloadAttributionInput
- Defined in ApiClient/index.ts:164

setSocketEventSubscriptions

setSocketEventSubscriptions(update: SocketEventSubscriptionInput): Promise<void>
Parameters
- update: SocketEventSubscriptionInput
Returns Promise<void>
- Defined in ApiClient/index.ts:180

Class ApiClient

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ApiClient

Properties

ReadonlyappId

Optional ReadonlyappSource

Readonlyattribution

Protectedlisteners

Type declaration

Optionalconnected?: (data: { network: SupernetType }) => void[]

Optionalconnecting?: (data: { network: SupernetType }) => void[]

Optionaldisconnected?: (data: { code: ErrorCode; reason: string }) => void[]

Readonlylogger

Accessors

auth

Returns AuthManager

isAuthenticated

Returns boolean

rest

Returns RestClient

socket

Returns IWebSocketClient

socketEnabled

Returns boolean

Methods

attributionHeaders

Parameters

Returns Record<string, string>

dispose

Returns void

Protectedemit

Type Parameters

Parameters

Returns void

handleAuthUpdated

Parameters

Returns void

handleSocketConnect

Parameters

Returns void

handleSocketConnecting

Returns void

handleSocketDisconnect

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

removeAllListeners

Type Parameters

Parameters

Returns void

resolveWorkloadAttribution

Parameters

Returns undefined | WorkloadAttributionInput

setSocketEventSubscriptions

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`appId

`Optional` `Readonly`appSource

`Readonly`attribution

`Protected`listeners

`Optional`connected?: (data: { network: SupernetType }) => void[]

`Optional`connecting?: (data: { network: SupernetType }) => void[]

`Optional`disconnected?: (data: { code: ErrorCode; reason: string }) => void[]

`Readonly`logger

`Protected`emit