@valoranchi/riot-client

Appearance

@valoranchi/riot-client / index / PartyApi

Interface: PartyApi ​

Defined in: src/client/api.ts:181

Methods ​

balanceTeams() ​

balanceTeams(): Promise<Party>

Defined in: src/client/api.ts:232

Returns ​

Promise<Party>

createInviteCode() ​

createInviteCode(): Promise<Party>

Defined in: src/client/api.ts:189

Returns ​

Promise<Party>

current() ​

current(): Promise<Party>

Defined in: src/client/api.ts:182

Returns ​

Promise<Party>

customGameConfigs() ​

customGameConfigs(): Promise<CustomGameConfigs>

Defined in: src/client/api.ts:208

Returns ​

Promise<CustomGameConfigs>

declineInvite() ​

declineInvite(inviteId): Promise<{ declined: boolean; inviteId: string; }>

Defined in: src/client/api.ts:211

Parameters ​

inviteId ​

string

Returns ​

Promise<{ declined: boolean; inviteId: string; }>

declineRequest() ​

declineRequest(requestId): Promise<{ declined: boolean; requestId: string; }>

Defined in: src/client/api.ts:215

Parameters ​

requestId ​

string

Returns ​

Promise<{ declined: boolean; requestId: string; }>

invite() ​

invite(riotId): Promise<Party>

Defined in: src/client/api.ts:183

Parameters ​

riotId ​

string

Returns ​

Promise<Party>

invites() ​

invites(): Promise<PartyInvite[]>

Defined in: src/client/api.ts:217

Returns ​

Promise<PartyInvite[]>

join() ​

join(partyId): Promise<Party>

Defined in: src/client/api.ts:209

Parameters ​

partyId ​

string

Returns ​

Promise<Party>

joinByCode() ​

joinByCode(code): Promise<Party>

Defined in: src/client/api.ts:193

Parameters ​

code ​

string

Returns ​

Promise<Party>

kick() ​

kick(puuid): Promise<Party>

Defined in: src/client/api.ts:185

Parameters ​

puuid ​

string

Returns ​

Promise<Party>

leave() ​

leave(): Promise<Party>

Defined in: src/client/api.ts:205

Returns ​

Promise<Party>

makeCustomGame() ​

makeCustomGame(): Promise<Party>

Defined in: src/client/api.ts:219

Returns ​

Promise<Party>

makeDefault() ​

makeDefault(queue): Promise<Party>

Defined in: src/client/api.ts:221

Parameters ​

queue ​

string

Returns ​

Promise<Party>

promote() ​

promote(puuid): Promise<Party>

Defined in: src/client/api.ts:187

Parameters ​

puuid ​

string

Returns ​

Promise<Party>

queues() ​

queues(): Promise<QueueConfig[]>

Defined in: src/client/api.ts:207

Returns ​

Promise<QueueConfig[]>

refresh() ​

refresh(): Promise<Party>

Defined in: src/client/api.ts:241

Returns ​

Promise<Party>

requests() ​

requests(): Promise<PartyRequest[]>

Defined in: src/client/api.ts:218

Returns ​

Promise<PartyRequest[]>

requestToJoin() ​

requestToJoin(partyId): Promise<{ partyId: string; requested: boolean; }>

Defined in: src/client/api.ts:213

Parameters ​

partyId ​

string

Returns ​

Promise<{ partyId: string; requested: boolean; }>

revokeInviteCode() ​

revokeInviteCode(): Promise<Party>

Defined in: src/client/api.ts:191

Returns ​

Promise<Party>

setAccessibility() ​

setAccessibility(accessibility): Promise<Party>

Defined in: src/client/api.ts:199

Parameters ​

accessibility ​

"open" | "closed"

Returns ​

Promise<Party>

setCustomGameSettings() ​

setCustomGameSettings(settings): Promise<Party>

Defined in: src/client/api.ts:223

Parameters ​

settings ​

CustomGameSettings

Returns ​

Promise<Party>

setModerator() ​

setModerator(puuid, isModerator): Promise<Party>

Defined in: src/client/api.ts:236

Parameters ​

puuid ​

string

isModerator ​

boolean

Returns ​

Promise<Party>

setPreferredServers() ​

setPreferredServers(ids): Promise<Party>

Defined in: src/client/api.ts:234

Parameters ​

ids ​

string[]

Returns ​

Promise<Party>

setQueue() ​

setQueue(queue): Promise<Party>

Defined in: src/client/api.ts:197

Parameters ​

queue ​

string

Returns ​

Promise<Party>

setReady() ​

setReady(ready): Promise<Party>

Defined in: src/client/api.ts:195

Parameters ​

ready ​

boolean

Returns ​

Promise<Party>

setTeam() ​

setTeam(puuid, team): Promise<Party>

Defined in: src/client/api.ts:225

Parameters ​

puuid ​

string

team ​

string

Returns ​

Promise<Party>

startCustomGame() ​

startCustomGame(): Promise<Party>

Defined in: src/client/api.ts:230

Returns ​

Promise<Party>

startMatchmaking() ​

startMatchmaking(): Promise<Party>

Defined in: src/client/api.ts:201

Returns ​

Promise<Party>

stopMatchmaking() ​

stopMatchmaking(): Promise<Party>

Defined in: src/client/api.ts:203

Returns ​

Promise<Party>

validateBalanceTeams() ​

validateBalanceTeams(): Promise<{ partyId: string; }>

Defined in: src/client/api.ts:233

Returns ​

Promise<{ partyId: string; }>

validateCreateInviteCode() ​

validateCreateInviteCode(): Promise<PartyActionRequest>

Defined in: src/client/api.ts:190

Returns ​

Promise<PartyActionRequest>

validateDeclineInvite() ​

validateDeclineInvite(inviteId): Promise<{ inviteId: string; partyId: string; }>

Defined in: src/client/api.ts:212

Parameters ​

inviteId ​

string

Returns ​

Promise<{ inviteId: string; partyId: string; }>

validateDeclineRequest() ​

validateDeclineRequest(requestId): Promise<{ partyId: string; requestId: string; }>

Defined in: src/client/api.ts:216

Parameters ​

requestId ​

string

Returns ​

Promise<{ partyId: string; requestId: string; }>

validateInvite() ​

validateInvite(riotId): Promise<PartyActionRequest>

Defined in: src/client/api.ts:184

Parameters ​

riotId ​

string

Returns ​

Promise<PartyActionRequest>

validateJoin() ​

validateJoin(partyId): Promise<{ partyId: string; }>

Defined in: src/client/api.ts:210

Parameters ​

partyId ​

string

Returns ​

Promise<{ partyId: string; }>

validateJoinByCode() ​

validateJoinByCode(code): Promise<PartyActionRequest>

Defined in: src/client/api.ts:194

Parameters ​

code ​

string

Returns ​

Promise<PartyActionRequest>

validateKick() ​

validateKick(puuid): Promise<PartyActionRequest>

Defined in: src/client/api.ts:186

Parameters ​

puuid ​

string

Returns ​

Promise<PartyActionRequest>

validateLeave() ​

validateLeave(): Promise<PartyActionRequest>

Defined in: src/client/api.ts:206

Returns ​

Promise<PartyActionRequest>

validateMakeCustomGame() ​

validateMakeCustomGame(): Promise<{ partyId: string; }>

Defined in: src/client/api.ts:220

Returns ​

Promise<{ partyId: string; }>

validateMakeDefault() ​

validateMakeDefault(queue): Promise<{ partyId: string; queue: string; }>

Defined in: src/client/api.ts:222

Parameters ​

queue ​

string

Returns ​

Promise<{ partyId: string; queue: string; }>

validatePromote() ​

validatePromote(puuid): Promise<PartyActionRequest>

Defined in: src/client/api.ts:188

Parameters ​

puuid ​

string

Returns ​

Promise<PartyActionRequest>

validateRefresh() ​

validateRefresh(): Promise<{ method: string; paths: string[]; }>

Defined in: src/client/api.ts:242

Returns ​

Promise<{ method: string; paths: string[]; }>

validateRequestToJoin() ​

validateRequestToJoin(partyId): Promise<{ body: unknown; method: string; path: string; }>

Defined in: src/client/api.ts:214

Parameters ​

partyId ​

string

Returns ​

Promise<{ body: unknown; method: string; path: string; }>

validateRevokeInviteCode() ​

validateRevokeInviteCode(): Promise<PartyActionRequest>

Defined in: src/client/api.ts:192

Returns ​

Promise<PartyActionRequest>

validateSetAccessibility() ​

validateSetAccessibility(accessibility): Promise<PartyActionRequest>

Defined in: src/client/api.ts:200

Parameters ​

accessibility ​

"open" | "closed"

Returns ​

Promise<PartyActionRequest>

validateSetCustomGameSettings() ​

validateSetCustomGameSettings(settings): Promise<Record<string, unknown>>

Defined in: src/client/api.ts:224

Parameters ​

settings ​

CustomGameSettings

Returns ​

Promise<Record<string, unknown>>

validateSetModerator() ​

validateSetModerator(puuid, isModerator): Promise<{ isModerator: boolean; partyId: string; puuid: string; }>

Defined in: src/client/api.ts:237

Parameters ​

puuid ​

string

isModerator ​

boolean

Returns ​

Promise<{ isModerator: boolean; partyId: string; puuid: string; }>

validateSetPreferredServers() ​

validateSetPreferredServers(ids): Promise<{ gamePodIds: string[]; partyId: string; }>

Defined in: src/client/api.ts:235

Parameters ​

ids ​

string[]

Returns ​

Promise<{ gamePodIds: string[]; partyId: string; }>

validateSetQueue() ​

validateSetQueue(queue): Promise<PartyActionRequest>

Defined in: src/client/api.ts:198

Parameters ​

queue ​

string

Returns ​

Promise<PartyActionRequest>

validateSetReady() ​

validateSetReady(ready): Promise<PartyActionRequest>

Defined in: src/client/api.ts:196

Parameters ​

ready ​

boolean

Returns ​

Promise<PartyActionRequest>

validateSetTeam() ​

validateSetTeam(puuid, team): Promise<{ partyId: string; puuid: string; team: string; }>

Defined in: src/client/api.ts:226

Parameters ​

puuid ​

string

team ​

string

Returns ​

Promise<{ partyId: string; puuid: string; team: string; }>

validateStartCustomGame() ​

validateStartCustomGame(): Promise<{ partyId: string; }>

Defined in: src/client/api.ts:231

Returns ​

Promise<{ partyId: string; }>

validateStartMatchmaking() ​

validateStartMatchmaking(): Promise<PartyActionRequest>

Defined in: src/client/api.ts:202

Returns ​

Promise<PartyActionRequest>

validateStopMatchmaking() ​

validateStopMatchmaking(): Promise<PartyActionRequest>

Defined in: src/client/api.ts:204

Returns ​

Promise<PartyActionRequest>

Not affiliated with Riot Games