Class MapsManager

Manages API operations related to playable Maps within Ranked Systems.

Hierarchy (View Summary)

BaseManager
- MapsManager

Index

Constructors

Properties

Methods

createMap getActiveMaps updateMap uploadImage

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

createMap

createMap(rankedSystemId: string, dto: CreateMapDto): Promise<MapEntity>
Creates a new map for a specific ranked system.
Parameters
- rankedSystemId: string
  The ID of the parent ranked system.
- dto: CreateMapDto
  The configuration for the new map.
Returns Promise<MapEntity>
A promise resolving to the newly created MapEntity.
- Defined in packages/sdk/src/managers/maps/maps.manager.ts:27

getActiveMaps

getActiveMaps(rankedSystemId: string): Promise<MapEntity[]>
Retrieves all active (non-deleted) maps for a specific ranked system.
Parameters
- rankedSystemId: string
  The ID of the parent ranked system.
Returns Promise<MapEntity[]>
A promise resolving to an array of MapEntity.
- Defined in packages/sdk/src/managers/maps/maps.manager.ts:16

updateMap

updateMap(id: string, dto: UpdateMapDto): Promise<MapEntity>
Updates an existing map. Note: You can also use map.update() if you already have the entity instance.
Parameters
- id: string
  The unique ID of the map.
- dto: UpdateMapDto
  The fields to update.
Returns Promise<MapEntity>
A promise resolving to the updated MapEntity.
- Defined in packages/sdk/src/managers/maps/maps.manager.ts:39

uploadImage

uploadImage(
    mapId: string,
    fileBuffer: Buffer,
    filename: string,
): Promise<{ success: boolean; url: string }>
Uploads or updates the image for a specific map using multipart/form-data.
Parameters
- mapId: string
  The unique ID of the map.
- fileBuffer: Buffer
  The binary buffer containing the image data.
- filename: string
  The filename with extension (e.g., 'arena.png').
Returns Promise<{ success: boolean; url: string }>
A promise resolving to an object containing the success status and the new URL.
- Defined in packages/sdk/src/managers/maps/maps.manager.ts:51