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

    Enumeration UserEventType

    The set of events that the User object can emit.

    Use these with User.subscribe to listen for things that happen to the agent, such as a status change, an incoming interaction, a queue assignment update, or an audio device change.

    // Listen for an incoming interaction
    user.subscribe(UserEventType.INTERACTION_RECEIVED, (event) => {
      console.log("Incoming interaction:", event.payload.interaction.interactionId);
    });

    // Listen for agent status changes
    user.subscribe(UserEventType.USER_STATUS_CHANGED, (event) => {
      console.log("New status:", event.payload.status.type);
    });
    Index

    Enumeration Members

    USER_STATUS_CHANGED USER_CX_LOGGED_IN USER_CX_LOGGED_OUT AUDIO_DEVICES_CHANGED NO_AUDIO_DEVICE_AVAILABLE AUDIO_DEVICE_PERMISSION_GRANTED AUDIO_DEVICE_PERMISSION_DENIED INTERACTION_RECEIVED INTERACTION_CREATED INTERACTION_VIEWING_STARTED USER_LOGOUT INTERACTION_AUTO_ACCEPT_FAILED

    Enumeration Members

    USER_STATUS_CHANGED: "userStatusChanged"

    Fired when the agent's status changes (e.g. Available → Busy). Not fired for CX login/logout - see USER_CX_LOGGED_IN and USER_CX_LOGGED_OUT. Payload: UserStatusChangedPayload

    USER_CX_LOGGED_IN: "userCxLoggedIn"

    Fired when the agent logs into the CX platform. Payload: UserCxLoggedInPayload

    USER_CX_LOGGED_OUT: "userCxLoggedOut"

    Fired when the agent logs out from the CX platform. Payload: UserCxLoggedOutPayload

    AUDIO_DEVICES_CHANGED: "audioDevicesChanged"

    Fired when audio devices are added or removed (e.g. headset plugged in or unplugged). Payload: DeviceChangeEventPayload

    NO_AUDIO_DEVICE_AVAILABLE: "noAudioDeviceAvailable"

    Fired when a device refresh confirms that a required audio-device kind is unavailable. Payload: NoAudioDeviceAvailablePayload

    AUDIO_DEVICE_PERMISSION_GRANTED: "audioDevicePermissionGranted"

    Fired when the agent grants microphone permission in the browser. Payload: AudioDevicePermissionGrantedPayload

    AUDIO_DEVICE_PERMISSION_DENIED: "audioDevicePermissionDenied"

    Fired when microphone permission is denied or revoked by the browser. Payload: AudioDevicePermissionDeniedPayload

    INTERACTION_RECEIVED: "interactionReceived"

    Fired when an inbound interaction is routed to the agent. Payload: InteractionReceivedPayload

    INTERACTION_CREATED: "interactionCreated"

    Fired when an interaction is created for the agent - either by initiating an outbound call (User.createOutboundVoiceInteraction) or by starting to view an interaction (User.viewInteraction). Payload: InteractionCreatedPayload

    INTERACTION_VIEWING_STARTED: "interactionViewingStarted"

    Fired when User.viewInteraction successfully starts a monitoring session — the Interaction object is now usable as a viewer. Payload: InteractionViewingStartedPayload

    USER_LOGOUT: "userLogout"

    Fired when the agent is logged out from the platform. Payload: UserLogoutPayload

    INTERACTION_AUTO_ACCEPT_FAILED: "interactionAutoAcceptFailed"

    Fired when the SDK attempted to auto-accept an incoming interaction but the underlying accept call failed before the interaction could connect. Interaction.canAccept returns true again so the agent can accept manually. Payload: InteractionAutoAcceptFailedPayload

    Settings

    Member Visibility

    On This Page

    Enumeration Members