Interface UserTrait

The interface implemented by User.

Defines the full contract for agent operations — identity, status management, CX login, queue access, interaction handling, event subscriptions, and media device control.

See

User

interface UserTrait {
    userId: string;
    userEmail: string;
    userFullName: string;
    userFirstName: string;
    userLastName: string;
    accountId: string;
    currentStatus: ReasonCode;
    isLoggedInToCx: boolean;
    canCreateOutboundVoiceInteraction: boolean;
    isEliteVoiceEnabled: boolean;
    isInteractionAutoAcceptEnabled: boolean;
    canClaimInteractionOwnership: boolean;
    canViewInteractionPublicly: boolean;
    canViewInteractionPrivately: boolean;
    refreshStatus(): Promise<ReasonCode>;
    getAssignedInteractions(): Interaction[];
    createOutboundVoiceInteraction(
        params: CreateOutboundVoiceInteractionParams,
    ): Promise<Interaction>;
    getAssignedQueues(): Queue[];
    defaultOutboundQueue: Queue | undefined;
    canLoginToCx(): boolean;
    loginToCx(reasonCode?: ReasonCode): Promise<void>;
    canLogoutFromCx(): boolean;
    logoutFromCx(reasonCode: ReasonCode): Promise<void>;
    getAssignableReasonCodes(): Promise<ReasonCode[]>;
    canChangeStatus(): boolean;
    changeStatus(reasonCode: ReasonCode): Promise<void>;
    subscribe<T extends UserEventType>(
        eventName: T,
        handler: UserEventHandler<T>,
    ): string;
    unsubscribe(eventName: UserEventType, handlerId: string): void;
    getAvailableAudioDevices(): Promise<AvailableAudioDevices>;
    getSelectedAudioDevices(): SelectedAudioDevices;
    canSetAudioInputDevice(): boolean;
    setAudioInputDevice(deviceId: string): void;
    canSetAudioOutputDevice(): boolean;
    setAudioOutputDevice(deviceId: string): void;
    getAudioDevicePermissionState(): MediaDevicePermissionState;
    getWebRtcRegistrationState(): WebRtcRegistrationState;
    viewInteraction(
        interactionId: string,
        params: ViewInteractionParams,
    ): Promise<Interaction>;
    getInteractionViews(): Promise<InteractionView[]>;
    refreshAssignedQueues(): Promise<Queue[]>;
}

Implemented by

User

Index

CX Login

isLoggedInToCx

isLoggedInToCx: boolean

Indicates whether the agent is currently logged into the CX platform

canLoginToCx

canLoginToCx(): boolean
Whether the agent can currently log into CX

Returns boolean
true if login is possible, false otherwise

loginToCx

loginToCx(reasonCode?: ReasonCode): Promise<void>
Logs the agent into the CX platform
Parameters
- OptionalreasonCode: ReasonCode
  Optional initial ReasonCode from getAssignableReasonCodes. When provided for a non-Elite agent, login and status change are applied in a single server request. Elite Voice agents must log in without a reason, wait for confirmation, and then call changeStatus().
Returns Promise<void>
A promise that resolves when CX login is complete

canLogoutFromCx

canLogoutFromCx(): boolean
Whether the agent can currently log out from CX

Returns boolean
true if logout is possible, false otherwise

logoutFromCx

logoutFromCx(reasonCode: ReasonCode): Promise<void>
Logs the agent out from the CX platform
Parameters
- reasonCode: ReasonCode
  The ReasonCode describing why the agent is logging out. Must be a LOGOUT-type reason from getAssignableReasonCodes.
Returns Promise<void>
A promise that resolves when CX logout is complete

Capabilities

`Readonly`isEliteVoiceEnabled

isEliteVoiceEnabled: boolean

Indicates whether the agent is licensed for Avaya Elite Voice (hybrid agent).

Hybrid agents handle voice via Elite Voice .

`Readonly`isInteractionAutoAcceptEnabled

isInteractionAutoAcceptEnabled: boolean

Whether auto-accept is enabled for the agent's incoming interactions.

When true, the SDK accepts incoming interactions on the agent's behalf across all channels. Auto-accept is suppressed for an audio interaction when another audio interaction is already in progress.

Events

subscribe<T extends UserEventType>(
eventName: T,
handler: UserEventHandler<T>,
): string
Subscribes to agent events
Type Parameters
- T extends UserEventType
Parameters
- eventName: T
  The UserEventType to subscribe to
- handler: UserEventHandler<T>
  Callback invoked each time the event fires
Returns string
A handler ID to pass to unsubscribe when done

unsubscribe

unsubscribe(eventName: UserEventType, handlerId: string): void
Unsubscribes a previously registered event handler
Parameters
- eventName: UserEventType
  The UserEventType to unsubscribe from
- handlerId: string
  The handler ID returned from subscribe
Returns void

Identity

userId

userId: string

The unique identifier for this agent

userEmail

userEmail: string

The agent's email address

userFullName

userFullName: string

The agent's full display name

userFirstName

userFirstName: string

The agent's first name

userLastName

userLastName: string

The agent's last name

accountId

accountId: string

The tenant identifier for the logged-in agent.

Stable for the lifetime of the session - the same value across every interaction the agent handles.

Interactions

canCreateOutboundVoiceInteraction

canCreateOutboundVoiceInteraction: boolean

Indicates whether the agent has permission to initiate outbound calls

getAssignedInteractions

getAssignedInteractions(): Interaction[]
Returns the agent's currently active interactions

Returns Interaction[]
An array of active Interaction objects

createOutboundVoiceInteraction

createOutboundVoiceInteraction(
params: CreateOutboundVoiceInteractionParams,
): Promise<Interaction>
Creates and initiates an outbound call interaction
Parameters
- params: CreateOutboundVoiceInteractionParams
  Queue ID, phone number, and optional details
Returns Promise<Interaction>
A promise that resolves to the new Interaction once the call is active

Media

getAvailableAudioDevices

getAvailableAudioDevices(): Promise<AvailableAudioDevices>
Returns the available audio input and output devices A resolved empty device kind confirms that enumeration succeeded but no device of that kind exists.

Returns Promise<AvailableAudioDevices>
A promise that resolves to the AvailableAudioDevices

Throws
If microphone permission is denied (ASE-4002) or device enumeration is unavailable (ASE-4001)

getSelectedAudioDevices

getSelectedAudioDevices(): SelectedAudioDevices
Returns the currently selected audio input and output devices

Returns SelectedAudioDevices
The SelectedAudioDevices representing the active device selection

canSetAudioInputDevice

canSetAudioInputDevice(): boolean
Whether an audio input device can currently be set

Returns boolean
true if the audio device service is available, false otherwise

setAudioInputDevice

setAudioInputDevice(deviceId: string): void
Sets the active audio input device
Parameters
- deviceId: string
  The ID of the input device to use
Returns void

canSetAudioOutputDevice

canSetAudioOutputDevice(): boolean
Whether an audio output device can currently be set

Returns boolean
true if the audio device service is available, false otherwise

setAudioOutputDevice

setAudioOutputDevice(deviceId: string): void
Sets the active audio output device
Parameters
- deviceId: string
  The ID of the output device to use
Returns void

getAudioDevicePermissionState

getAudioDevicePermissionState(): MediaDevicePermissionState
Returns the current microphone permission state

Returns MediaDevicePermissionState
The current MediaDevicePermissionState

getWebRtcRegistrationState

getWebRtcRegistrationState(): WebRtcRegistrationState
Returns the current WebRTC registration status

Returns WebRtcRegistrationState
The current WebRtcRegistrationState

Queues

getAssignedQueues

getAssignedQueues(): Queue[]
Returns the list of queues currently assigned to this agent

Returns Queue[]
An array of Queue objects assigned to this agent

`Readonly`defaultOutboundQueue

defaultOutboundQueue: Queue | undefined

The configured default outbound queue when this SDK session was initialized or most recently logged into CX.

Returns undefined for Elite Voice users or when the outbound queue is not configured.

Returns

The default outbound queue, or undefined when not configured

refreshAssignedQueues

refreshAssignedQueues(): Promise<Queue[]>
Refreshes the agent's queue assignments from the server

Returns Promise<Queue[]>
A promise that resolves to the updated list of Queue objects

Status Management

currentStatus

currentStatus: ReasonCode

The agent's current status

refreshStatus

refreshStatus(): Promise<ReasonCode>
Fetches the agent's current status from the server

Returns Promise<ReasonCode>
A promise that resolves to the current ReasonCode status

getAssignableReasonCodes

getAssignableReasonCodes(): Promise<ReasonCode[]>
Fetches the available reason codes for status changes

Returns Promise<ReasonCode[]>
A promise that resolves to an array of available ReasonCode objects

canChangeStatus

canChangeStatus(): boolean
Whether the agent can currently change their status

Returns boolean
true if a status change is possible, false otherwise

changeStatus

changeStatus(reasonCode: ReasonCode): Promise<void>
Changes the agent's status to the specified reason
Parameters
- reasonCode: ReasonCode
  The target ReasonCode to set
Returns Promise<void>
A promise that resolves when the status change has been applied

Viewing Interactions

canClaimInteractionOwnership

canClaimInteractionOwnership: boolean

Whether the agent may claim ownership of an interaction they are viewing.

canViewInteractionPublicly

canViewInteractionPublicly: boolean

Whether the agent may view an interaction publicly (visible to the parties).

canViewInteractionPrivately

canViewInteractionPrivately: boolean

Whether the agent may view an interaction privately (silent monitoring).

viewInteraction

viewInteraction(
interactionId: string,
params: ViewInteractionParams,
): Promise<Interaction>
Starts monitoring an interaction as a private or public viewer. Creates the interaction delegate, sends a viewerAdd request, and dispatches UserEventType.INTERACTION_VIEWING_STARTED on success. Use Interaction.joinCall to join audio after viewing starts.
Parameters
- interactionId: string
  The ID of the interaction to monitor
- params: ViewInteractionParams
  ViewInteractionParams — set viewPrivately: true for silent monitoring
Returns Promise<Interaction>
Promise that resolves to the Interaction

getInteractionViews

getInteractionViews(): Promise<InteractionView[]>
Fetches the list of interaction views available to the current user. Views define server-side filters for the interaction list (e.g., "All Active Interactions"). Call InteractionView.getInteractions on a returned view to fetch its interactions.

Returns Promise<InteractionView[]>
A promise that resolves to an array of InteractionView

Interface UserTrait

See

Implemented by

Index

CX Login

Capabilities

Events

Identity

Interactions

Media

Queues

Status Management

Viewing Interactions

CX Login

isLoggedInToCx

canLoginToCx

Returns boolean

loginToCx

Parameters

Returns Promise<void>

canLogoutFromCx

Returns boolean

logoutFromCx

Parameters

Returns Promise<void>

Capabilities

ReadonlyisEliteVoiceEnabled

ReadonlyisInteractionAutoAcceptEnabled

Events

subscribe

Type Parameters

Parameters

Returns string

unsubscribe

Parameters

Returns void

Identity

userId

userEmail

userFullName

userFirstName

userLastName

accountId

Interactions

canCreateOutboundVoiceInteraction

getAssignedInteractions

Returns Interaction[]

createOutboundVoiceInteraction

Parameters

Returns Promise<Interaction>

Media

getAvailableAudioDevices

Returns Promise<AvailableAudioDevices>

Throws

getSelectedAudioDevices

Returns SelectedAudioDevices

canSetAudioInputDevice

Returns boolean

setAudioInputDevice

Parameters

Returns void

canSetAudioOutputDevice

Returns boolean

setAudioOutputDevice

Parameters

Returns void

getAudioDevicePermissionState

Returns MediaDevicePermissionState

getWebRtcRegistrationState

Returns WebRtcRegistrationState

Queues

getAssignedQueues

Returns Queue[]

ReadonlydefaultOutboundQueue

Returns

refreshAssignedQueues

Returns Promise<Queue[]>

Status Management

currentStatus

refreshStatus

`Readonly`isEliteVoiceEnabled

`Readonly`isInteractionAutoAcceptEnabled

`Readonly`defaultOutboundQueue