Class PartiesManager

Manages API operations related to User Parties. Handles creating parties, managing members, and disbanding.

Hierarchy (View Summary)

BaseManager
- PartiesManager

Index

Constructors

Properties

Methods

addMember changeLeader create disbandParty getById getByUserId removeMember

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

addMember

addMember(partyId: string, userId: number): Promise<PartyEntity>
Adds a member to an existing party.
Parameters
- partyId: string
  The UUID of the party.
- userId: number
  The ID of the user to add.
Returns Promise<PartyEntity>
A promise resolving to the updated PartyEntity.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:48

changeLeader

changeLeader(partyId: string, dto: ChangePartyLeaderDto): Promise<PartyEntity>
Changes the leader of an existing party.
Parameters
- partyId: string
  The UUID of the party.
- dto: ChangePartyLeaderDto
  The payload containing the new leader's ID.
Returns Promise<PartyEntity>
A promise resolving to the updated PartyEntity.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:59

create

create(dto: CreatePartyDto): Promise<PartyEntity>
Creates a new party with the specified user as the leader.
Parameters
- dto: CreatePartyDto
  The payload containing the leader's ID.
Returns Promise<PartyEntity>
A promise resolving to the newly created PartyEntity.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:37

disbandParty

disbandParty(partyId: string): Promise<void>
Disbands a party entirely.
Parameters
- partyId: string
  The UUID of the party.
Returns Promise<void>
A promise resolving when the party is disbanded.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:86

getById

getById(partyId: string): Promise<PartyEntity>
Retrieves a party by its unique ID.
Parameters
- partyId: string
  The UUID of the party.
Returns Promise<PartyEntity>
A promise resolving to the PartyEntity.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:17

getByUserId

getByUserId(userId: number): Promise<PartyEntity>
Retrieves the party that a specific user currently belongs to.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<PartyEntity>
A promise resolving to the PartyEntity.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:27

removeMember

removeMember(partyId: string, userId: number): Promise<PartyEntity | null>
Removes a member from a party.
Parameters
- partyId: string
  The UUID of the party.
- userId: number
  The ID of the user to remove.
Returns Promise<PartyEntity | null>
A promise resolving to the updated PartyEntity, or null if the party was disbanded.
- Defined in packages/sdk/src/managers/parties/parties.manager.ts:71