Class WebSocketApi

WebSocketApi - object-oriented interface WebSocketApi

Implements

WebSocketApiInterface

Index

Constructors

Methods

getWebSocketAuthToken

Constructors

constructor

new WebSocketApi(configuration: ConfigurationRestAPI): WebSocketApi
Parameters
- configuration: ConfigurationRestAPI
Returns WebSocketApi
- Defined in clients/web3-wallet/src/rest-api/modules/web-socket-api.ts:113

Methods

getWebSocketAuthToken

getWebSocketAuthToken(
requestParameters?: GetWebSocketAuthTokenRequest,
): Promise<RestApiResponse<GetWebSocketAuthTokenResponse>>
Get a WebSocket auth token before connecting to the WebSocket stream service. For details on WebSocket usage, please refer to the WebSocket documentation.
Parameters
- requestParameters: GetWebSocketAuthTokenRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetWebSocketAuthTokenResponse>>

Throws

Memberof
WebSocketApi

See
Binance API Documentation
Implementation of WebSocketApiInterface.getWebSocketAuthToken
- Defined in clients/web3-wallet/src/rest-api/modules/web-socket-api.ts:128