• Parameters

    • socketClientId: string

      the sockets client identifier

    • url: string

      the uri to reach the socket

    • channel: string

      the channel name/id

    • onopen: Function

      The function to be invoked when the web socket is opened.

    • onmessage: Function

      The function to be invoked when a message is received.

    • onerror: Function

      The function to be invoked when an error occurs.

    • onclose: Function

      The function to be invoked when the web socket is closed.

    • behaviors: any

      functions which are invoked whenever a message is received

    • autoConnect: boolean

      Whether or not to automatically open the socket. Defaults to false.

    Returns void

Generated using TypeDoc