Class ApiClient

Hierarchy (View Summary)

TypedEventEmitter<ApiClientEvents>
- ApiClient

Index

Constructors

Properties

appId appSource? listeners logger

Accessors

auth isAuthenticated rest socket socketEnabled

Methods

dispose emit handleAuthUpdated handleSocketConnect handleSocketDisconnect off on once removeAllListeners setSocketEventSubscriptions

Constructors

constructor

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

Properties

`Readonly`appId

appId: string

`Optional` `Readonly`appSource

appSource?: string

`Protected`listeners

listeners: {
connected?: (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.
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:124

isAuthenticated

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

rest

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

socket

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

socketEnabled

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

Methods

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:192

`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:178

handleSocketConnect

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

handleSocketDisconnect

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

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

setSocketEventSubscriptions

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