Interface WebSocketApiInterface

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

  • OptionalrequestParameters: GetWebSocketAuthTokenRequest

    Request parameters.

  Returns Promise<RestApiResponse<GetWebSocketAuthTokenResponse>>

  Throws

  Memberof

  WebSocketApiInterface