Class QueuesManager

Manages API operations related to Matchmaking Queues. Handles creating queues, joining, leaving, and checking queue status.

Hierarchy (View Summary)

BaseManager
- QueuesManager

Index

Constructors

Properties

Methods

create delete getActiveQueues getUserInfo join leave

Constructors

constructor

new QueuesManager(client: RankedClient): QueuesManager
Parameters
- client: RankedClient
Returns QueuesManager
Inherited from BaseManager.constructor
- Defined in packages/sdk/src/managers/base.manager.ts:11

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

create

create(rankedSystemId: string, dto: CreateQueueDto): Promise<QueueEntity>
Creates a new queue for a specific ranked system.
Parameters
- rankedSystemId: string
  The ID of the parent ranked system.
- dto: CreateQueueDto
  The configuration for the new queue.
Returns Promise<QueueEntity>
A promise resolving to the newly created QueueEntity.
- Defined in packages/sdk/src/managers/queues/queues.manager.ts:28

delete

delete(queueId: string): Promise<QueueEntity>
Deletes a queue and clears its cache.
Parameters
- queueId: string
  The ID of the queue to delete.
Returns Promise<QueueEntity>
A promise resolving to the deleted QueueEntity.
- Defined in packages/sdk/src/managers/queues/queues.manager.ts:38

getActiveQueues

getActiveQueues(): Promise<QueueEntity[]>
Retrieves all currently active queues across all ranked systems.

Returns Promise<QueueEntity[]>
A promise resolving to an array of QueueEntity.
- Defined in packages/sdk/src/managers/queues/queues.manager.ts:17

getUserInfo

getUserInfo(userId: number): Promise<UserInQueueEntity>
Retrieves the queue cached information for a specific user. Throws an error if the user is not currently in any queue.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<UserInQueueEntity>
A promise resolving to a UserInQueueEntity.
- Defined in packages/sdk/src/managers/queues/queues.manager.ts:49

join

join(dto: JoinQueueDto): Promise<QueueCapacity>
Makes a user join a queue based on the Discord Voice Channel they entered. Checks for ELO requirements, bans, and active queue status.
Parameters
- dto: JoinQueueDto
  The payload containing user ID, channel ID, and roles.
Returns Promise<QueueCapacity>
A promise resolving to the new QueueCapacity.
Example
```
const capacity = await client.queues.join({
 userId: 1,
 discordChannelId: '466861191931756544',
 discordRoles: ['role-1', 'role-2']
});
console.log(`Queue is now at ${capacity.currentSize}/${capacity.totalNeeded} players.`);
```
- Defined in packages/sdk/src/managers/queues/queues.manager.ts:69

leave

leave(userId: number): Promise<QueueCapacity>
Makes a user leave their current queue.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<QueueCapacity>
A promise resolving to the updated QueueCapacity.
- Defined in packages/sdk/src/managers/queues/queues.manager.ts:79