Class GamesManager

Manages API operations related to Games (Matches). Handles fetching match history, scoring, cancelling, and undoing game results.

Hierarchy (View Summary)

BaseManager
- GamesManager

Index

Constructors

Properties

Methods

cancelGame getById getUserHistory scoreGame undoScore

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

cancelGame

cancelGame(gameId: number, dto: CancelGameDto): Promise<{ message: string }>
Forcibly cancels an ongoing game without affecting player ELO ratings.
Parameters
- gameId: number
  The ID of the game to cancel.
- dto: CancelGameDto
  The payload containing the cancellation reason.
Returns Promise<{ message: string }>
A promise resolving to a success message.
- Defined in packages/sdk/src/managers/games/games.manager.ts:52

getById

getById(gameId: number): Promise<GameEntity>
Retrieves the complete details of a specific game.
Parameters
- gameId: number
  The unique ID of the game.
Returns Promise<GameEntity>
A promise resolving to the GameEntity.
- Defined in packages/sdk/src/managers/games/games.manager.ts:17

getUserHistory

getUserHistory(userId: number, limit?: number): Promise<GameEntity[]>
Retrieves the recent match history for a specific user.
Parameters
- userId: number
  The ID of the user.
- limit: number = 10
  The maximum number of games to return (defaults to 10).
Returns Promise<GameEntity[]>
A promise resolving to an array of GameEntity.
- Defined in packages/sdk/src/managers/games/games.manager.ts:28

scoreGame

scoreGame(gameId: number, dto: ScoreGameDto): Promise<{ message: string }>
Submits the final results of an active game, calculating ELO changes.
Parameters
- gameId: number
  The ID of the game to score.
- dto: ScoreGameDto
  The payload containing the winning team index and player stats.
Returns Promise<{ message: string }>
A promise resolving to a success message.
- Defined in packages/sdk/src/managers/games/games.manager.ts:41

undoScore

undoScore(gameId: number): Promise<{ message: string }>
Undoes the results of a previously scored game, reverting ELO changes and statistics.
Parameters
- gameId: number
  The ID of the game to undo.
Returns Promise<{ message: string }>
A promise resolving to a success message.
- Defined in packages/sdk/src/managers/games/games.manager.ts:62