@avaya/infinity-agent-sdk - v1.0.0
    Preparing search index...

    Enumeration WebSocketConnectionEventType

    The set of events emitted when the SDK's WebSocket connection changes state.

    Subscribe to these via AvayaInfinityAgentSdk.subscribe to drive connection-state UI (e.g. a "reconnecting…" banner) and to detect unrecoverable loss of connectivity.

    AvayaInfinityAgentSdk.subscribe(WebSocketConnectionEventType.CONNECTION_ERROR, (event) => {
      console.error("Connection error:", event.payload.error.message);
    });

    AvayaInfinityAgentSdk.subscribe(WebSocketConnectionEventType.CONNECTION_FAILED, (event) => {
      console.error("All retries exhausted:", event.payload.error.message);
    });
    Index

    Enumeration Members

    CONNECTING CONNECTED CONNECTION_ERROR RECONNECTION_ATTEMPT_FAILED RECONNECTING CONNECTION_FAILED CONNECTION_CLOSED

    Enumeration Members

    CONNECTING: "webSocketConnecting"

    Entering WebSocketConnectionState.CONNECTING state (init()).

    CONNECTED: "webSocketConnected"

    Successfully connected or reconnected - entering WebSocketConnectionState.CONNECTED.

    CONNECTION_ERROR: "webSocketConnectionError"

    Unexpected error or disconnection while in WebSocketConnectionState.CONNECTED. The SDK will transition to WebSocketConnectionState.RECONNECTING and begin automatic reconnection attempts.

    RECONNECTION_ATTEMPT_FAILED: "webSocketReconnectionAttemptFailed"

    A single reconnection attempt failed. The SDK enters WebSocketConnectionState.AWAITING_RECONNECTION and will retry after the backoff period indicated by WebSocketReconnectionAttemptFailedPayload.retryAfter.

    RECONNECTING: "webSocketReconnecting"

    Entering WebSocketConnectionState.RECONNECTING state. Fired when a backoff/cooldown period completes, or when retryWebSocketConnection() is called from the WebSocketConnectionState.FAILED state.

    CONNECTION_FAILED: "webSocketConnectionFailed"

    All reconnection attempts exhausted - entering WebSocketConnectionState.FAILED. Call retryWebSocketConnection() to manually trigger a new reconnection sequence.

    CONNECTION_CLOSED: "webSocketConnectionClosed"

    Connection intentionally torn down via destroy(), or initial connect failure - entering WebSocketConnectionState.CLOSED.

    Settings

    Member Visibility

    On This Page

    Enumeration Members