Class Queue

Represents a queue assigned to the agent for receiving interactions.

Obtained from User.getAssignedQueues or refreshed via User.refreshAssignedQueues. An agent must log into a queue before the platform routes interactions to them from it. Multiple queues can be logged into simultaneously.

Typical usage

Retrieve assigned queues via User.getAssignedQueues.
Check isLoggedIn to determine the current login state for each queue.
Call login to start receiving interactions from a queue.
Call logout with a ReasonCode of type LOGOUT when the agent is done.

Area	Key members
Identity	queueId, queueName, queueType
Status	isLoggedIn, loggedInAt, isAutoLogin
Actions	canLogin, login, canLogout, logout
Events	subscribe, unsubscribe

Example

const queues = user.getAssignedQueues();
const queue = queues.find(q => q.queueName === "Support");

if (queue && !queue.isLoggedIn) {
  await queue.login();
  console.log("Logged into:", queue.queueName, "at", queue.loggedInAt);
}

// Log out with a logout reason code
const reasons = await user.getAssignableReasonCodes();
const logoutReason = reasons.find(r => r.type === ReasonType.LOGOUT);
if (logoutReason) {
  await queue.logout(logoutReason);
}

See

Implements

QueueTrait

Index

Constructors

constructor

new Queue(): Queue
Returns Queue

Actions

canLogin

canLogin(): boolean
Whether the agent can log into this queue right now.

Returns true when the platform rules allow login (e.g. the agent is logged into CX, has access to the queue, and is not already logged in). Returns false otherwise.

Returns boolean
Example
```
if (queue.canLogin()) {
  await queue.login();
}
```
Implementation of QueueTrait.canLogin

login(): Promise<void>
Logs the agent into this queue so the platform can start routing interactions to them.

Returns Promise<void>
A promise that resolves when the agent is successfully logged into the queue.
Throws
AvayaInfinityAgentSdkError If the login request fails. * *
Example
```
* if (!queue.isLoggedIn) {
    *   await queue.login();
    *   console.log("Now receiving interactions from:", queue.queueName);
    * }
    *
    *
```
Implementation of QueueTrait.login

canLogout

canLogout(): boolean
Whether the agent can log out of this queue right now.

Returns true when the platform rules allow logout (e.g. the agent is logged into CX, has access to the queue, and is currently logged in). Returns false otherwise.

Returns boolean
Example
```
if (queue.canLogout()) {
  const reasons = await user.getAssignableReasonCodes();
  const logoutReason = reasons.find(r => r.type === ReasonType.LOGOUT);
  if (logoutReason) await queue.logout(logoutReason);
}
```
Implementation of QueueTrait.canLogout

logout

logout(reasonCode: ReasonCode): Promise<void>
Logs the agent out of this queue so the platform stops routing interactions to them.

The reasonCode must be a ReasonCode with type LOGOUT from User.getAssignableReasonCodes.
Parameters
- reasonCode: ReasonCode
  The logout reason code. Must have type equal to ReasonType.LOGOUT.
Returns Promise<void>
A promise that resolves when the agent is successfully logged out of the queue.
Throws
AvayaInfinityAgentSdkError If the logout request fails. * *
Example
```
* const reasons = await user.getAssignableReasonCodes();
    * const logoutReason = reasons.find(r => r.type === ReasonType.LOGOUT);
    * if (logoutReason) {
    *   await queue.logout(logoutReason);
    * }
    *
    *
```
Implementation of QueueTrait.logout

Events

subscribe<T extends QUEUE_STATUS_CHANGED>(
eventName: T,
handler: QueueEventHandler<T>,
): string
Subscribes to queue events.
Type Parameters
- T extends QUEUE_STATUS_CHANGED
Parameters
- eventName: T
  The QueueEventType to subscribe to
- handler: QueueEventHandler<T>
  Callback invoked each time the event fires
Returns string
A handler ID to pass to unsubscribe when done
Example
```
const handlerId = queue.subscribe(
  QueueEventType.QUEUE_STATUS_CHANGED,
  (event) => {
    console.log("Queue login status:", event.payload.loggedIn);
  }
);
```
Implementation of QueueTrait.subscribe

unsubscribe

unsubscribe(eventName: QUEUE_STATUS_CHANGED, handlerId: string): void
Unsubscribes a previously registered event handler.
Parameters
- eventName: QUEUE_STATUS_CHANGED
  The QueueEventType to unsubscribe from
- handlerId: string
  The handler ID returned from subscribe
Returns void
Implementation of QueueTrait.unsubscribe

Identity

queueId

get queueId(): string
The unique identifier of the queue.

Returns string
Implementation of QueueTrait.queueId

queueName

get queueName(): string
The display name of the queue as configured in the contact center platform.

Returns string
Implementation of QueueTrait.queueName

queueType

get queueType(): QueueType
The category of the queue.

GENERAL and HYBRID queues support explicit login / logout; PERSONAL queues do not — the platform manages them automatically. UNKNOWN indicates the backend did not send the type field (typically an older backend version); the SDK does not gate login/logout for UNKNOWN — any server-side restriction surfaces via the server's rejection response instead.

Returns QueueType
Example
```
const loggable = user.getAssignedQueues()
  .filter(q => q.queueType !== QueueType.PERSONAL);
```
Implementation of QueueTrait.queueType

Status

isLoggedIn

get isLoggedIn(): boolean
Whether the agent is currently logged into this queue and eligible to receive interactions from it.

Returns boolean
Implementation of QueueTrait.isLoggedIn

loggedInAt

get loggedInAt(): Date | undefined
The timestamp when the agent last logged into this queue. undefined if the agent is not currently logged in.

Returns Date | undefined
Implementation of QueueTrait.loggedInAt

isAutoLogin

get isAutoLogin(): boolean
Whether the platform automatically logs the agent into this queue upon logging into CX.

Returns boolean
Implementation of QueueTrait.isAutoLogin

Class Queue

Typical usage

Example

See

Implements

Index

Constructors

Actions

Events

Identity

Status

Constructors

constructor

Returns Queue

Actions

canLogin

Returns boolean

Example

login

Returns Promise<void>

Throws

Example

canLogout

Returns boolean

Example

logout

Parameters

Returns Promise<void>

Throws

Example

Events

subscribe

Type Parameters

Parameters

Returns string

Example

unsubscribe

Parameters

Returns void

Identity

queueId

Returns string

queueName

Returns string

queueType

Returns QueueType

Example

Status

isLoggedIn

Returns boolean

loggedInAt

Returns Date | undefined

isAutoLogin

Returns boolean

Settings

On This Page