Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the base class for WebSocket Service

Hierarchy

  • WSService

Index

Constructors

  • Create instance for websocket service

    example
    new WSService();
    

    Returns WSService

Properties

auth: CXoneAuth

Methods

  • Method used to get connected message

    example
    getConnectedMessage();
    

    Returns DynamicDirectoyMessage

    • return the websocket request
  • getConnectionMessage(type: string): WsRequest
  • Method used to get connection message with access token

    example
    this.getConnectionMessage('heartbeat');
    

    Parameters

    • type: string

    Returns WsRequest

    • return the websocket request
  • Method used to get error message with error message

    example
    getErrorMessage('error message');
    

    Parameters

    • errorMessage: string

    Returns DynamicDirectoyMessage

    • return the error message
  • Method used to get reconnected message with access token

    example
    getReconnectedMessage();
    

    Returns DynamicDirectoyMessage

    • return the websocket request
  • getSubscriptionMessage(subscriptionId: string): WsRequest
  • Method used to get subscribe message with subscriptionId

    example
    getSubscriptionMessage(subscriptionId);
    

    Parameters

    • subscriptionId: string

    Returns WsRequest

    • return the websocket subscription request
  • getUnsubscribeMessage(subscriptionId: string): WsRequest
  • Method used to get unsubscribe from web socket

    example
    getUnsubscribeMessage(subscriptionId);
    

    Parameters

    • subscriptionId: string

    Returns WsRequest

    • return the websocket unsubscribe request

Generated using TypeDoc