ringcentral.websocket.events

 1class WebSocketEvents:
 2    """
 3        WebSocketEvents class representing various events related to WebSocket communication.
 4
 5        Attributes:
 6            getTokenError (str): Event triggered when an error occurs while retrieving the WebSocket token.
 7            createConnectionError (str): Event triggered when an error occurs while creating a WebSocket connection.
 8            connectionCreated (str): Event triggered when a WebSocket connection is successfully created.
 9            closeConnectionError (str): Event triggered when an error occurs while closing a WebSocket connection.
10            recoverConnectionError (str): Event triggered when an error occurs while recovering a WebSocket connection.
11            receiveMessage (str): Event triggered when a message is received over the WebSocket connection.
12            receiveMessageError (str): Event triggered when an exception occurs while receiving a message or while dispatching a received message to a receive-message handler. Its sole argument is the original exception. Unlike createConnectionError, it is not used for connection creation or the initial handshake.
13            sendMessageError (str): Event triggered when an error occurs while sending a message over the WebSocket connection.
14            connectionNotReady (str): Event triggered when attempting to perform an action while the WebSocket connection is not ready.
15            createSubscriptionError (str): Event triggered when an error occurs while creating a subscription.
16            updateSubscriptionError (str): Event triggered when an error occurs while updating a subscription.
17            removeSubscriptionError (str): Event triggered when an error occurs while removing a subscription.
18            subscriptionCreated (str): Event triggered when a subscription is successfully created.
19            subscriptionUpdated (str): Event triggered when a subscription is successfully updated.
20            subscriptionRemoved (str): Event triggered when a subscription is successfully removed.
21            receiveSubscriptionNotification (str): Event triggered when a subscription notification is received.
22    """
23    getTokenError = 'getTokenError'
24    createConnectionError = 'createConnectionError'
25    connectionCreated = 'connectionCreated'
26    closeConnectionError = 'closeConnectionError'
27    recoverConnectionError = 'recoverConnectionError'
28    receiveMessage = 'receiveMessage'
29    receiveMessageError = 'receiveMessageError'
30    sendMessageError = 'sendMessageError'
31    connectionNotReady = 'connectionNotReady'
32    createSubscriptionError = 'createSubscriptionError'
33    updateSubscriptionError = 'updateSubscriptionError'
34    removeSubscriptionError = 'removeSubscriptionError'
35    subscriptionCreated = 'subscriptionCreated'
36    subscriptionUpdated = 'subscriptionUpdated'
37    subscriptionRemoved = 'subscriptionRemoved'
38    receiveSubscriptionNotification = 'receiveSubscriptionNotification'
39
40    def __init__(self):
41        pass