ringcentral.websocket.events

View Source

 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            sendMessageError (str): Event triggered when an error occurs while sending a message over the WebSocket connection.
13            connectionNotReady (str): Event triggered when attempting to perform an action while the WebSocket connection is not ready.
14            createSubscriptionError (str): Event triggered when an error occurs while creating a subscription.
15            updateSubscriptionError (str): Event triggered when an error occurs while updating a subscription.
16            removeSubscriptionError (str): Event triggered when an error occurs while removing a subscription.
17            subscriptionCreated (str): Event triggered when a subscription is successfully created.
18            subscriptionUpdated (str): Event triggered when a subscription is successfully updated.
19            subscriptionRemoved (str): Event triggered when a subscription is successfully removed.
20            receiveSubscriptionNotification (str): Event triggered when a subscription notification is received.
21    """
22    getTokenError = 'getTokenError'
23    createConnectionError = 'createConnectionError'
24    connectionCreated = 'connectionCreated'
25    closeConnectionError = 'closeConnectionError'
26    recoverConnectionError = 'recoverConnectionError'
27    receiveMessage = 'receiveMessage'
28    sendMessageError = 'sendMessageError'
29    connectionNotReady = 'connectionNotReady'
30    createSubscriptionError = 'createSubscriptionError'
31    updateSubscriptionError = 'updateSubscriptionError'
32    removeSubscriptionError = 'removeSubscriptionError'
33    subscriptionCreated = 'subscriptionCreated'
34    subscriptionUpdated = 'subscriptionUpdated'
35    subscriptionRemoved = 'subscriptionRemoved'
36    receiveSubscriptionNotification = 'receiveSubscriptionNotification'
37
38    def __init__(self):
39        pass

class WebSocketEvents: View Source

 3class WebSocketEvents:
 4    """
 5        WebSocketEvents class representing various events related to WebSocket communication.
 6
 7        Attributes:
 8            getTokenError (str): Event triggered when an error occurs while retrieving the WebSocket token.
 9            createConnectionError (str): Event triggered when an error occurs while creating a WebSocket connection.
10            connectionCreated (str): Event triggered when a WebSocket connection is successfully created.
11            closeConnectionError (str): Event triggered when an error occurs while closing a WebSocket connection.
12            recoverConnectionError (str): Event triggered when an error occurs while recovering a WebSocket connection.
13            receiveMessage (str): Event triggered when a message is received over the WebSocket connection.
14            sendMessageError (str): Event triggered when an error occurs while sending a message over the WebSocket connection.
15            connectionNotReady (str): Event triggered when attempting to perform an action while the WebSocket connection is not ready.
16            createSubscriptionError (str): Event triggered when an error occurs while creating a subscription.
17            updateSubscriptionError (str): Event triggered when an error occurs while updating a subscription.
18            removeSubscriptionError (str): Event triggered when an error occurs while removing a subscription.
19            subscriptionCreated (str): Event triggered when a subscription is successfully created.
20            subscriptionUpdated (str): Event triggered when a subscription is successfully updated.
21            subscriptionRemoved (str): Event triggered when a subscription is successfully removed.
22            receiveSubscriptionNotification (str): Event triggered when a subscription notification is received.
23    """
24    getTokenError = 'getTokenError'
25    createConnectionError = 'createConnectionError'
26    connectionCreated = 'connectionCreated'
27    closeConnectionError = 'closeConnectionError'
28    recoverConnectionError = 'recoverConnectionError'
29    receiveMessage = 'receiveMessage'
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

WebSocketEvents class representing various events related to WebSocket communication.

Attributes: getTokenError (str): Event triggered when an error occurs while retrieving the WebSocket token. createConnectionError (str): Event triggered when an error occurs while creating a WebSocket connection. connectionCreated (str): Event triggered when a WebSocket connection is successfully created. closeConnectionError (str): Event triggered when an error occurs while closing a WebSocket connection. recoverConnectionError (str): Event triggered when an error occurs while recovering a WebSocket connection. receiveMessage (str): Event triggered when a message is received over the WebSocket connection. sendMessageError (str): Event triggered when an error occurs while sending a message over the WebSocket connection. connectionNotReady (str): Event triggered when attempting to perform an action while the WebSocket connection is not ready. createSubscriptionError (str): Event triggered when an error occurs while creating a subscription. updateSubscriptionError (str): Event triggered when an error occurs while updating a subscription. removeSubscriptionError (str): Event triggered when an error occurs while removing a subscription. subscriptionCreated (str): Event triggered when a subscription is successfully created. subscriptionUpdated (str): Event triggered when a subscription is successfully updated. subscriptionRemoved (str): Event triggered when a subscription is successfully removed. receiveSubscriptionNotification (str): Event triggered when a subscription notification is received.

getTokenError = 'getTokenError'

createConnectionError = 'createConnectionError'

connectionCreated = 'connectionCreated'

closeConnectionError = 'closeConnectionError'

recoverConnectionError = 'recoverConnectionError'

receiveMessage = 'receiveMessage'

sendMessageError = 'sendMessageError'

connectionNotReady = 'connectionNotReady'

createSubscriptionError = 'createSubscriptionError'

updateSubscriptionError = 'updateSubscriptionError'

removeSubscriptionError = 'removeSubscriptionError'

subscriptionCreated = 'subscriptionCreated'

subscriptionUpdated = 'subscriptionUpdated'

subscriptionRemoved = 'subscriptionRemoved'

receiveSubscriptionNotification = 'receiveSubscriptionNotification'