Class Party

Hierarchy (view full)

WebClientService
- Party

Index

Constructors

Properties

regionURL request

Accessors

CustomGame MatchMaking PartyCode Player

Methods

declineJoinRequest get getMUCToken getVoiceToken inviteByDisplayName refreshCompetitiveTier refreshPings refreshPlayerIdentity setAccessibility

Constructors

constructor

new Party(request, regionURL): Party
Parameters
- request: AxiosInstance
- regionURL: WebClientRegionURL
Returns Party
Inherited from WebClientService.constructor
- Defined in web-client/src/client/WebClientService.ts:9

Properties

`Protected` `Readonly`regionURL

regionURL: WebClientRegionURL

`Protected` `Readonly`request

request: AxiosInstance

Accessors

CustomGame

get CustomGame(): CustomGame
Returns CustomGame
- Defined in web-client/src/service/Party.ts:206

MatchMaking

get MatchMaking(): MatchMaking
Returns MatchMaking
- Defined in web-client/src/service/Party.ts:198

PartyCode

get PartyCode(): PartyCode
Returns PartyCode
- Defined in web-client/src/service/Party.ts:210

Player

get Player(): Player
Returns Player
- Defined in web-client/src/service/Party.ts:202

Methods

declineJoinRequest

declineJoinRequest(partyId, requestId): PromiseResponse<any>
Parameters
- partyId: string
- requestId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:194

get

get(partyId): PromiseResponse<Party.Party>
Parameters
- partyId: string
Returns PromiseResponse<Party.Party>
- Defined in web-client/src/service/Party.ts:172

getMUCToken

getMUCToken(partyId): PromiseResponse<any>
Parameters
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:176

getVoiceToken

getVoiceToken(partyId): PromiseResponse<any>
Parameters
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:180

inviteByDisplayName

inviteByDisplayName(partyId, gameName, tagLine): PromiseResponse<any>
Parameters
- partyId: string
- gameName: string
- tagLine: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:190

refreshCompetitiveTier

refreshCompetitiveTier(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:160

refreshPings

refreshPings(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:168

refreshPlayerIdentity

refreshPlayerIdentity(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:164

setAccessibility

setAccessibility(partyId, accessibility): PromiseResponse<any>
Parameters
- partyId: string
- accessibility: Accessibility
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:184