PartyService | @rivet-gg/party

Hierarchy

PartyServiceClient
PartyServiceClient
- PartyService

Implements

Client<ServiceInputTypes, ServiceOutputTypes, PartyServiceClientResolvedConfig>
Client<ServiceInputTypes, ServiceOutputTypes, PartyServiceClientResolvedConfig>

Constructors

constructor

new PartyService(configuration: PartyServiceClientConfig): PartyService

Inherited from PartyServiceClient.constructor

Overrides Client.__constructor
- Defined in clients/client/src/PartyServiceClient.ts:307
Parameters
- configuration: PartyServiceClientConfig
Returns PartyService

Properties

Readonly config

config: PartyServiceClientResolvedConfig

The resolved configuration of PartyServiceClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

createParty

createParty(args: CreatePartyCommandInput, options?: __HttpHandlerOptions): Promise<CreatePartyCommandOutput>
createParty(args: CreatePartyCommandInput, cb: (err: any, data?: CreatePartyCommandOutput) => void): void
createParty(args: CreatePartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartyCommandOutput) => void): void
createParty(args: CreatePartyCommandInput, options?: __HttpHandlerOptions): Promise<CreatePartyCommandOutput>
createParty(args: CreatePartyCommandInput, cb: (err: any, data?: CreatePartyCommandOutput) => void): void
createParty(args: CreatePartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartyCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:99
Creates a new party.

Parameters
- args: CreatePartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreatePartyCommandOutput>
- Defined in clients/client/src/PartyService.ts:103
Creates a new party.

Parameters
- args: CreatePartyCommandInput
- cb: (err: any, data?: CreatePartyCommandOutput) => void
  - - (err: any, data?: CreatePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:107
Creates a new party.

Parameters
- args: CreatePartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreatePartyCommandOutput) => void
  - - (err: any, data?: CreatePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:25
Creates a new party.

Parameters
- args: CreatePartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreatePartyCommandOutput>
- Defined in dist-types/PartyService.d.ts:26
Creates a new party.

Parameters
- args: CreatePartyCommandInput
- cb: (err: any, data?: CreatePartyCommandOutput) => void
  - - (err: any, data?: CreatePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:27
Creates a new party.

Parameters
- args: CreatePartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreatePartyCommandOutput) => void
  - - (err: any, data?: CreatePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyCommandOutput
      Returns void
Returns void

createPartyInvite

createPartyInvite(args: CreatePartyInviteCommandInput, options?: __HttpHandlerOptions): Promise<CreatePartyInviteCommandOutput>
createPartyInvite(args: CreatePartyInviteCommandInput, cb: (err: any, data?: CreatePartyInviteCommandOutput) => void): void
createPartyInvite(args: CreatePartyInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartyInviteCommandOutput) => void): void
createPartyInvite(args: CreatePartyInviteCommandInput, options?: __HttpHandlerOptions): Promise<CreatePartyInviteCommandOutput>
createPartyInvite(args: CreatePartyInviteCommandInput, cb: (err: any, data?: CreatePartyInviteCommandOutput) => void): void
createPartyInvite(args: CreatePartyInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartyInviteCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:134
Creates a new party invite for the current identity's party.

Identity must be the party leader.

Parameters
- args: CreatePartyInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreatePartyInviteCommandOutput>
- Defined in clients/client/src/PartyService.ts:138
Creates a new party invite for the current identity's party. Identity must be the party leader.

Parameters
- args: CreatePartyInviteCommandInput
- cb: (err: any, data?: CreatePartyInviteCommandOutput) => void
  - - (err: any, data?: CreatePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyInviteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:142
Creates a new party invite for the current identity's party. Identity must be the party leader.

Parameters
- args: CreatePartyInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreatePartyInviteCommandOutput) => void
  - - (err: any, data?: CreatePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:33
Creates a new party invite for the current identity's party.

Identity must be the party leader.

Parameters
- args: CreatePartyInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreatePartyInviteCommandOutput>
- Defined in dist-types/PartyService.d.ts:34
Creates a new party invite for the current identity's party. Identity must be the party leader.

Parameters
- args: CreatePartyInviteCommandInput
- cb: (err: any, data?: CreatePartyInviteCommandOutput) => void
  - - (err: any, data?: CreatePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:35
Creates a new party invite for the current identity's party. Identity must be the party leader.

Parameters
- args: CreatePartyInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreatePartyInviteCommandOutput) => void
  - - (err: any, data?: CreatePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreatePartyInviteCommandOutput
      Returns void
Returns void

destroy

destroy(): void

Inherited from PartyServiceClient.destroy

Overrides Client.destroy
- Defined in clients/client/src/PartyServiceClient.ts:370
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

findMatchmakerLobbyForParty

findMatchmakerLobbyForParty(args: FindMatchmakerLobbyForPartyCommandInput, options?: __HttpHandlerOptions): Promise<FindMatchmakerLobbyForPartyCommandOutput>
findMatchmakerLobbyForParty(args: FindMatchmakerLobbyForPartyCommandInput, cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void): void
findMatchmakerLobbyForParty(args: FindMatchmakerLobbyForPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void): void
findMatchmakerLobbyForParty(args: FindMatchmakerLobbyForPartyCommandInput, options?: __HttpHandlerOptions): Promise<FindMatchmakerLobbyForPartyCommandOutput>
findMatchmakerLobbyForParty(args: FindMatchmakerLobbyForPartyCommandInput, cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void): void
findMatchmakerLobbyForParty(args: FindMatchmakerLobbyForPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:581
Attempts to make the current identity's party find a lobby based on the given criteria.

If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

This request will use the party player count configured for the lobby group.

See FindLobby.

Parameters
- args: FindMatchmakerLobbyForPartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<FindMatchmakerLobbyForPartyCommandOutput>
- Defined in clients/client/src/PartyService.ts:585
Attempts to make the current identity's party find a lobby based on the given criteria. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. This request will use the party player count configured for the lobby group. See FindLobby.

Parameters
- args: FindMatchmakerLobbyForPartyCommandInput
- cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: FindMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:589
Attempts to make the current identity's party find a lobby based on the given criteria. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. This request will use the party player count configured for the lobby group. See FindLobby.

Parameters
- args: FindMatchmakerLobbyForPartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: FindMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:129
Attempts to make the current identity's party find a lobby based on the given criteria.

If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

This request will use the party player count configured for the lobby group.

See FindLobby.

Parameters
- args: FindMatchmakerLobbyForPartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<FindMatchmakerLobbyForPartyCommandOutput>
- Defined in dist-types/PartyService.d.ts:130
Attempts to make the current identity's party find a lobby based on the given criteria. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. This request will use the party player count configured for the lobby group. See FindLobby.

Parameters
- args: FindMatchmakerLobbyForPartyCommandInput
- cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: FindMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:131
Attempts to make the current identity's party find a lobby based on the given criteria. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. This request will use the party player count configured for the lobby group. See FindLobby.

Parameters
- args: FindMatchmakerLobbyForPartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: FindMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: FindMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void

getPartyFromInvite

getPartyFromInvite(args: GetPartyFromInviteCommandInput, options?: __HttpHandlerOptions): Promise<GetPartyFromInviteCommandOutput>
getPartyFromInvite(args: GetPartyFromInviteCommandInput, cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void): void
getPartyFromInvite(args: GetPartyFromInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void): void
getPartyFromInvite(args: GetPartyFromInviteCommandInput, options?: __HttpHandlerOptions): Promise<GetPartyFromInviteCommandOutput>
getPartyFromInvite(args: GetPartyFromInviteCommandInput, cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void): void
getPartyFromInvite(args: GetPartyFromInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:167
Fetches a party based on a given invite.

Parameters
- args: GetPartyFromInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartyFromInviteCommandOutput>
- Defined in clients/client/src/PartyService.ts:171
Fetches a party based on a given invite.

Parameters
- args: GetPartyFromInviteCommandInput
- cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void
  - - (err: any, data?: GetPartyFromInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyFromInviteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:175
Fetches a party based on a given invite.

Parameters
- args: GetPartyFromInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void
  - - (err: any, data?: GetPartyFromInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyFromInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:39
Fetches a party based on a given invite.

Parameters
- args: GetPartyFromInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartyFromInviteCommandOutput>
- Defined in dist-types/PartyService.d.ts:40
Fetches a party based on a given invite.

Parameters
- args: GetPartyFromInviteCommandInput
- cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void
  - - (err: any, data?: GetPartyFromInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyFromInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:41
Fetches a party based on a given invite.

Parameters
- args: GetPartyFromInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartyFromInviteCommandOutput) => void
  - - (err: any, data?: GetPartyFromInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyFromInviteCommandOutput
      Returns void
Returns void

getPartyProfile

getPartyProfile(args: GetPartyProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetPartyProfileCommandOutput>
getPartyProfile(args: GetPartyProfileCommandInput, cb: (err: any, data?: GetPartyProfileCommandOutput) => void): void
getPartyProfile(args: GetPartyProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartyProfileCommandOutput) => void): void
getPartyProfile(args: GetPartyProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetPartyProfileCommandOutput>
getPartyProfile(args: GetPartyProfileCommandInput, cb: (err: any, data?: GetPartyProfileCommandOutput) => void): void
getPartyProfile(args: GetPartyProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartyProfileCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:200
Returns a party profile.

Parameters
- args: GetPartyProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartyProfileCommandOutput>
- Defined in clients/client/src/PartyService.ts:204
Returns a party profile.

Parameters
- args: GetPartyProfileCommandInput
- cb: (err: any, data?: GetPartyProfileCommandOutput) => void
  - - (err: any, data?: GetPartyProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:208
Returns a party profile.

Parameters
- args: GetPartyProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartyProfileCommandOutput) => void
  - - (err: any, data?: GetPartyProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:45
Returns a party profile.

Parameters
- args: GetPartyProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartyProfileCommandOutput>
- Defined in dist-types/PartyService.d.ts:46
Returns a party profile.

Parameters
- args: GetPartyProfileCommandInput
- cb: (err: any, data?: GetPartyProfileCommandOutput) => void
  - - (err: any, data?: GetPartyProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:47
Returns a party profile.

Parameters
- args: GetPartyProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartyProfileCommandOutput) => void
  - - (err: any, data?: GetPartyProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartyProfileCommandOutput
      Returns void
Returns void

getPartySelfProfile

getPartySelfProfile(args: GetPartySelfProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetPartySelfProfileCommandOutput>
getPartySelfProfile(args: GetPartySelfProfileCommandInput, cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void): void
getPartySelfProfile(args: GetPartySelfProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void): void
getPartySelfProfile(args: GetPartySelfProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetPartySelfProfileCommandOutput>
getPartySelfProfile(args: GetPartySelfProfileCommandInput, cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void): void
getPartySelfProfile(args: GetPartySelfProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:233
Returns a party profile for the party the current identity is a member of.

Parameters
- args: GetPartySelfProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartySelfProfileCommandOutput>
- Defined in clients/client/src/PartyService.ts:237
Returns a party profile for the party the current identity is a member of.

Parameters
- args: GetPartySelfProfileCommandInput
- cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void
  - - (err: any, data?: GetPartySelfProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:241
Returns a party profile for the party the current identity is a member of.

Parameters
- args: GetPartySelfProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void
  - - (err: any, data?: GetPartySelfProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:51
Returns a party profile for the party the current identity is a member of.

Parameters
- args: GetPartySelfProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartySelfProfileCommandOutput>
- Defined in dist-types/PartyService.d.ts:52
Returns a party profile for the party the current identity is a member of.

Parameters
- args: GetPartySelfProfileCommandInput
- cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void
  - - (err: any, data?: GetPartySelfProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:53
Returns a party profile for the party the current identity is a member of.

Parameters
- args: GetPartySelfProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartySelfProfileCommandOutput) => void
  - - (err: any, data?: GetPartySelfProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfProfileCommandOutput
      Returns void
Returns void

getPartySelfSummary

getPartySelfSummary(args: GetPartySelfSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetPartySelfSummaryCommandOutput>
getPartySelfSummary(args: GetPartySelfSummaryCommandInput, cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void): void
getPartySelfSummary(args: GetPartySelfSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void): void
getPartySelfSummary(args: GetPartySelfSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetPartySelfSummaryCommandOutput>
getPartySelfSummary(args: GetPartySelfSummaryCommandInput, cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void): void
getPartySelfSummary(args: GetPartySelfSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:266
Returns a party summary for the party the current identity is a member of.

Parameters
- args: GetPartySelfSummaryCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartySelfSummaryCommandOutput>
- Defined in clients/client/src/PartyService.ts:270
Returns a party summary for the party the current identity is a member of.

Parameters
- args: GetPartySelfSummaryCommandInput
- cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void
  - - (err: any, data?: GetPartySelfSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfSummaryCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:274
Returns a party summary for the party the current identity is a member of.

Parameters
- args: GetPartySelfSummaryCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void
  - - (err: any, data?: GetPartySelfSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfSummaryCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:57
Returns a party summary for the party the current identity is a member of.

Parameters
- args: GetPartySelfSummaryCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartySelfSummaryCommandOutput>
- Defined in dist-types/PartyService.d.ts:58
Returns a party summary for the party the current identity is a member of.

Parameters
- args: GetPartySelfSummaryCommandInput
- cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void
  - - (err: any, data?: GetPartySelfSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfSummaryCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:59
Returns a party summary for the party the current identity is a member of.

Parameters
- args: GetPartySelfSummaryCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartySelfSummaryCommandOutput) => void
  - - (err: any, data?: GetPartySelfSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySelfSummaryCommandOutput
      Returns void
Returns void

getPartySummary

getPartySummary(args: GetPartySummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetPartySummaryCommandOutput>
getPartySummary(args: GetPartySummaryCommandInput, cb: (err: any, data?: GetPartySummaryCommandOutput) => void): void
getPartySummary(args: GetPartySummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartySummaryCommandOutput) => void): void
getPartySummary(args: GetPartySummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetPartySummaryCommandOutput>
getPartySummary(args: GetPartySummaryCommandInput, cb: (err: any, data?: GetPartySummaryCommandOutput) => void): void
getPartySummary(args: GetPartySummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartySummaryCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:299
Returns a party summary.

Parameters
- args: GetPartySummaryCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartySummaryCommandOutput>
- Defined in clients/client/src/PartyService.ts:303
Returns a party summary.

Parameters
- args: GetPartySummaryCommandInput
- cb: (err: any, data?: GetPartySummaryCommandOutput) => void
  - - (err: any, data?: GetPartySummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySummaryCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:307
Returns a party summary.

Parameters
- args: GetPartySummaryCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartySummaryCommandOutput) => void
  - - (err: any, data?: GetPartySummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySummaryCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:63
Returns a party summary.

Parameters
- args: GetPartySummaryCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetPartySummaryCommandOutput>
- Defined in dist-types/PartyService.d.ts:64
Returns a party summary.

Parameters
- args: GetPartySummaryCommandInput
- cb: (err: any, data?: GetPartySummaryCommandOutput) => void
  - - (err: any, data?: GetPartySummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySummaryCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:65
Returns a party summary.

Parameters
- args: GetPartySummaryCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetPartySummaryCommandOutput) => void
  - - (err: any, data?: GetPartySummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetPartySummaryCommandOutput
      Returns void
Returns void

joinMatchmakerLobbyForParty

joinMatchmakerLobbyForParty(args: JoinMatchmakerLobbyForPartyCommandInput, options?: __HttpHandlerOptions): Promise<JoinMatchmakerLobbyForPartyCommandOutput>
joinMatchmakerLobbyForParty(args: JoinMatchmakerLobbyForPartyCommandInput, cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void): void
joinMatchmakerLobbyForParty(args: JoinMatchmakerLobbyForPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void): void
joinMatchmakerLobbyForParty(args: JoinMatchmakerLobbyForPartyCommandInput, options?: __HttpHandlerOptions): Promise<JoinMatchmakerLobbyForPartyCommandOutput>
joinMatchmakerLobbyForParty(args: JoinMatchmakerLobbyForPartyCommandInput, cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void): void
joinMatchmakerLobbyForParty(args: JoinMatchmakerLobbyForPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:626
Attempts to make the current identity's party join a specific matchmaker lobby.

This request will use the party player count configured for the lobby group.

If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

Identity must be the party leader.

See JoinLobby.

Parameters
- args: JoinMatchmakerLobbyForPartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<JoinMatchmakerLobbyForPartyCommandOutput>
- Defined in clients/client/src/PartyService.ts:630
Attempts to make the current identity's party join a specific matchmaker lobby. This request will use the party player count configured for the lobby group. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Identity must be the party leader. See JoinLobby.

Parameters
- args: JoinMatchmakerLobbyForPartyCommandInput
- cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:634
Attempts to make the current identity's party join a specific matchmaker lobby. This request will use the party player count configured for the lobby group. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Identity must be the party leader. See JoinLobby.

Parameters
- args: JoinMatchmakerLobbyForPartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:147
Attempts to make the current identity's party join a specific matchmaker lobby.

This request will use the party player count configured for the lobby group.

If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

Identity must be the party leader.

See JoinLobby.

Parameters
- args: JoinMatchmakerLobbyForPartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<JoinMatchmakerLobbyForPartyCommandOutput>
- Defined in dist-types/PartyService.d.ts:148
Attempts to make the current identity's party join a specific matchmaker lobby. This request will use the party player count configured for the lobby group. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Identity must be the party leader. See JoinLobby.

Parameters
- args: JoinMatchmakerLobbyForPartyCommandInput
- cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:149
Attempts to make the current identity's party join a specific matchmaker lobby. This request will use the party player count configured for the lobby group. If succeeds, all party members will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Identity must be the party leader. See JoinLobby.

Parameters
- args: JoinMatchmakerLobbyForPartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput) => void
  - - (err: any, data?: JoinMatchmakerLobbyForPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinMatchmakerLobbyForPartyCommandOutput
      Returns void
Returns void

joinParty

joinParty(args: JoinPartyCommandInput, options?: __HttpHandlerOptions): Promise<JoinPartyCommandOutput>
joinParty(args: JoinPartyCommandInput, cb: (err: any, data?: JoinPartyCommandOutput) => void): void
joinParty(args: JoinPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinPartyCommandOutput) => void): void
joinParty(args: JoinPartyCommandInput, options?: __HttpHandlerOptions): Promise<JoinPartyCommandOutput>
joinParty(args: JoinPartyCommandInput, cb: (err: any, data?: JoinPartyCommandOutput) => void): void
joinParty(args: JoinPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinPartyCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:332
Joins a party using a given party invite.

Parameters
- args: JoinPartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<JoinPartyCommandOutput>
- Defined in clients/client/src/PartyService.ts:336
Joins a party using a given party invite.

Parameters
- args: JoinPartyCommandInput
- cb: (err: any, data?: JoinPartyCommandOutput) => void
  - - (err: any, data?: JoinPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinPartyCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:340
Joins a party using a given party invite.

Parameters
- args: JoinPartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: JoinPartyCommandOutput) => void
  - - (err: any, data?: JoinPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinPartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:69
Joins a party using a given party invite.

Parameters
- args: JoinPartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<JoinPartyCommandOutput>
- Defined in dist-types/PartyService.d.ts:70
Joins a party using a given party invite.

Parameters
- args: JoinPartyCommandInput
- cb: (err: any, data?: JoinPartyCommandOutput) => void
  - - (err: any, data?: JoinPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinPartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:71
Joins a party using a given party invite.

Parameters
- args: JoinPartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: JoinPartyCommandOutput) => void
  - - (err: any, data?: JoinPartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinPartyCommandOutput
      Returns void
Returns void

kickMember

kickMember(args: KickMemberCommandInput, options?: __HttpHandlerOptions): Promise<KickMemberCommandOutput>
kickMember(args: KickMemberCommandInput, cb: (err: any, data?: KickMemberCommandOutput) => void): void
kickMember(args: KickMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: KickMemberCommandOutput) => void): void
kickMember(args: KickMemberCommandInput, options?: __HttpHandlerOptions): Promise<KickMemberCommandOutput>
kickMember(args: KickMemberCommandInput, cb: (err: any, data?: KickMemberCommandOutput) => void): void
kickMember(args: KickMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: KickMemberCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:367
Kicks a member from the current identity's current party.

Identity must be the party leader.

Parameters
- args: KickMemberCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<KickMemberCommandOutput>
- Defined in clients/client/src/PartyService.ts:371
Kicks a member from the current identity's current party. Identity must be the party leader.

Parameters
- args: KickMemberCommandInput
- cb: (err: any, data?: KickMemberCommandOutput) => void
  - - (err: any, data?: KickMemberCommandOutput): void
    - Parameters
      - err: any
      - Optional data: KickMemberCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:375
Kicks a member from the current identity's current party. Identity must be the party leader.

Parameters
- args: KickMemberCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: KickMemberCommandOutput) => void
  - - (err: any, data?: KickMemberCommandOutput): void
    - Parameters
      - err: any
      - Optional data: KickMemberCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:77
Kicks a member from the current identity's current party.

Identity must be the party leader.

Parameters
- args: KickMemberCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<KickMemberCommandOutput>
- Defined in dist-types/PartyService.d.ts:78
Kicks a member from the current identity's current party. Identity must be the party leader.

Parameters
- args: KickMemberCommandInput
- cb: (err: any, data?: KickMemberCommandOutput) => void
  - - (err: any, data?: KickMemberCommandOutput): void
    - Parameters
      - err: any
      - Optional data: KickMemberCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:79
Kicks a member from the current identity's current party. Identity must be the party leader.

Parameters
- args: KickMemberCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: KickMemberCommandOutput) => void
  - - (err: any, data?: KickMemberCommandOutput): void
    - Parameters
      - err: any
      - Optional data: KickMemberCommandOutput
      Returns void
Returns void

leaveParty

leaveParty(args: LeavePartyCommandInput, options?: __HttpHandlerOptions): Promise<LeavePartyCommandOutput>
leaveParty(args: LeavePartyCommandInput, cb: (err: any, data?: LeavePartyCommandOutput) => void): void
leaveParty(args: LeavePartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LeavePartyCommandOutput) => void): void
leaveParty(args: LeavePartyCommandInput, options?: __HttpHandlerOptions): Promise<LeavePartyCommandOutput>
leaveParty(args: LeavePartyCommandInput, cb: (err: any, data?: LeavePartyCommandOutput) => void): void
leaveParty(args: LeavePartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LeavePartyCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:400
Leaves the current identity's party.

Parameters
- args: LeavePartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<LeavePartyCommandOutput>
- Defined in clients/client/src/PartyService.ts:404
Leaves the current identity's party.

Parameters
- args: LeavePartyCommandInput
- cb: (err: any, data?: LeavePartyCommandOutput) => void
  - - (err: any, data?: LeavePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeavePartyCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:408
Leaves the current identity's party.

Parameters
- args: LeavePartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: LeavePartyCommandOutput) => void
  - - (err: any, data?: LeavePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeavePartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:83
Leaves the current identity's party.

Parameters
- args: LeavePartyCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<LeavePartyCommandOutput>
- Defined in dist-types/PartyService.d.ts:84
Leaves the current identity's party.

Parameters
- args: LeavePartyCommandInput
- cb: (err: any, data?: LeavePartyCommandOutput) => void
  - - (err: any, data?: LeavePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeavePartyCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:85
Leaves the current identity's party.

Parameters
- args: LeavePartyCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: LeavePartyCommandOutput) => void
  - - (err: any, data?: LeavePartyCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeavePartyCommandOutput
      Returns void
Returns void

requestMatchmakerPlayer

requestMatchmakerPlayer(args: RequestMatchmakerPlayerCommandInput, options?: __HttpHandlerOptions): Promise<RequestMatchmakerPlayerCommandOutput>
requestMatchmakerPlayer(args: RequestMatchmakerPlayerCommandInput, cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void): void
requestMatchmakerPlayer(args: RequestMatchmakerPlayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void): void
requestMatchmakerPlayer(args: RequestMatchmakerPlayerCommandInput, options?: __HttpHandlerOptions): Promise<RequestMatchmakerPlayerCommandOutput>
requestMatchmakerPlayer(args: RequestMatchmakerPlayerCommandInput, cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void): void
requestMatchmakerPlayer(args: RequestMatchmakerPlayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:683
Attempts to create a new matchmaker player for the current identity.

If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Parameters
- args: RequestMatchmakerPlayerCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RequestMatchmakerPlayerCommandOutput>
- Defined in clients/client/src/PartyService.ts:687
Attempts to create a new matchmaker player for the current identity. If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Parameters
- args: RequestMatchmakerPlayerCommandInput
- cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void
  - - (err: any, data?: RequestMatchmakerPlayerCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RequestMatchmakerPlayerCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:691
Attempts to create a new matchmaker player for the current identity. If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Parameters
- args: RequestMatchmakerPlayerCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void
  - - (err: any, data?: RequestMatchmakerPlayerCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RequestMatchmakerPlayerCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:177
Attempts to create a new matchmaker player for the current identity.

If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby.

Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Parameters
- args: RequestMatchmakerPlayerCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RequestMatchmakerPlayerCommandOutput>
- Defined in dist-types/PartyService.d.ts:178
Attempts to create a new matchmaker player for the current identity. If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Parameters
- args: RequestMatchmakerPlayerCommandInput
- cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void
  - - (err: any, data?: RequestMatchmakerPlayerCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RequestMatchmakerPlayerCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:179
Attempts to create a new matchmaker player for the current identity. If succeeds, the identity will receive a GlobalEventMatchmakerLobbyJoin event with all the information required to join the lobby. Only relevant if the party is already in a matchmaker lobby.

When To Use This Endpoint

Joining a Party Already In a Lobby

When an identity joins a party that's already in a lobby, a new matchmaker player will not automatically be created unless JoinParty#matchmaker_auto_join_lobby is set to true.

Leaving the Game and Returning

If the user leaves the game and comes back but is still in the party, then they will have to create a new matchmaker player.

Failed to Connect to Lobby or Disconnected From Lobby

If the user failed to establish a connection with the lobby or they got disconnected, their matchmaker player will be removed. Use this endpoint to create a new matchmaker player.

Parameters
- args: RequestMatchmakerPlayerCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: RequestMatchmakerPlayerCommandOutput) => void
  - - (err: any, data?: RequestMatchmakerPlayerCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RequestMatchmakerPlayerCommandOutput
      Returns void
Returns void

revokePartyInvite

revokePartyInvite(args: RevokePartyInviteCommandInput, options?: __HttpHandlerOptions): Promise<RevokePartyInviteCommandOutput>
revokePartyInvite(args: RevokePartyInviteCommandInput, cb: (err: any, data?: RevokePartyInviteCommandOutput) => void): void
revokePartyInvite(args: RevokePartyInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokePartyInviteCommandOutput) => void): void
revokePartyInvite(args: RevokePartyInviteCommandInput, options?: __HttpHandlerOptions): Promise<RevokePartyInviteCommandOutput>
revokePartyInvite(args: RevokePartyInviteCommandInput, cb: (err: any, data?: RevokePartyInviteCommandOutput) => void): void
revokePartyInvite(args: RevokePartyInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokePartyInviteCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:435
Revokes a party invite from the current identity's party.

Identity must be the party leader.

Parameters
- args: RevokePartyInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RevokePartyInviteCommandOutput>
- Defined in clients/client/src/PartyService.ts:439
Revokes a party invite from the current identity's party. Identity must be the party leader.

Parameters
- args: RevokePartyInviteCommandInput
- cb: (err: any, data?: RevokePartyInviteCommandOutput) => void
  - - (err: any, data?: RevokePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RevokePartyInviteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:443
Revokes a party invite from the current identity's party. Identity must be the party leader.

Parameters
- args: RevokePartyInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: RevokePartyInviteCommandOutput) => void
  - - (err: any, data?: RevokePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RevokePartyInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:91
Revokes a party invite from the current identity's party.

Identity must be the party leader.

Parameters
- args: RevokePartyInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RevokePartyInviteCommandOutput>
- Defined in dist-types/PartyService.d.ts:92
Revokes a party invite from the current identity's party. Identity must be the party leader.

Parameters
- args: RevokePartyInviteCommandInput
- cb: (err: any, data?: RevokePartyInviteCommandOutput) => void
  - - (err: any, data?: RevokePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RevokePartyInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:93
Revokes a party invite from the current identity's party. Identity must be the party leader.

Parameters
- args: RevokePartyInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: RevokePartyInviteCommandOutput) => void
  - - (err: any, data?: RevokePartyInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RevokePartyInviteCommandOutput
      Returns void
Returns void

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options?: HandlerOptions): Promise<OutputType>
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, cb: (err: any, data?: OutputType) => void): void
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options: __HttpHandlerOptions, cb: (err: any, data?: OutputType) => void): void

Inherited from PartyServiceClient.send

Overrides PartyServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
Inherited from PartyServiceClient.send

Overrides PartyServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
Inherited from PartyServiceClient.send

Overrides PartyServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- options: __HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

sendJoinRequest

sendJoinRequest(args: SendJoinRequestCommandInput, options?: __HttpHandlerOptions): Promise<SendJoinRequestCommandOutput>
sendJoinRequest(args: SendJoinRequestCommandInput, cb: (err: any, data?: SendJoinRequestCommandOutput) => void): void
sendJoinRequest(args: SendJoinRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendJoinRequestCommandOutput) => void): void
sendJoinRequest(args: SendJoinRequestCommandInput, options?: __HttpHandlerOptions): Promise<SendJoinRequestCommandOutput>
sendJoinRequest(args: SendJoinRequestCommandInput, cb: (err: any, data?: SendJoinRequestCommandOutput) => void): void
sendJoinRequest(args: SendJoinRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendJoinRequestCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:465
Parameters
- args: SendJoinRequestCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SendJoinRequestCommandOutput>
- Defined in clients/client/src/PartyService.ts:469
Parameters
- args: SendJoinRequestCommandInput
- cb: (err: any, data?: SendJoinRequestCommandOutput) => void
  - - (err: any, data?: SendJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SendJoinRequestCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:473
Parameters
- args: SendJoinRequestCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SendJoinRequestCommandOutput) => void
  - - (err: any, data?: SendJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SendJoinRequestCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:94
Parameters
- args: SendJoinRequestCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SendJoinRequestCommandOutput>
- Defined in dist-types/PartyService.d.ts:95
Parameters
- args: SendJoinRequestCommandInput
- cb: (err: any, data?: SendJoinRequestCommandOutput) => void
  - - (err: any, data?: SendJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SendJoinRequestCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:96
Parameters
- args: SendJoinRequestCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SendJoinRequestCommandOutput) => void
  - - (err: any, data?: SendJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SendJoinRequestCommandOutput
      Returns void
Returns void

setPartyPublicity

setPartyPublicity(args: SetPartyPublicityCommandInput, options?: __HttpHandlerOptions): Promise<SetPartyPublicityCommandOutput>
setPartyPublicity(args: SetPartyPublicityCommandInput, cb: (err: any, data?: SetPartyPublicityCommandOutput) => void): void
setPartyPublicity(args: SetPartyPublicityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPartyPublicityCommandOutput) => void): void
setPartyPublicity(args: SetPartyPublicityCommandInput, options?: __HttpHandlerOptions): Promise<SetPartyPublicityCommandOutput>
setPartyPublicity(args: SetPartyPublicityCommandInput, cb: (err: any, data?: SetPartyPublicityCommandOutput) => void): void
setPartyPublicity(args: SetPartyPublicityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPartyPublicityCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:502
Sets the publicity of a party.

This configures who can view and join the party.

Identity must be the party leader.

Parameters
- args: SetPartyPublicityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SetPartyPublicityCommandOutput>
- Defined in clients/client/src/PartyService.ts:506
Sets the publicity of a party. This configures who can view and join the party. Identity must be the party leader.

Parameters
- args: SetPartyPublicityCommandInput
- cb: (err: any, data?: SetPartyPublicityCommandOutput) => void
  - - (err: any, data?: SetPartyPublicityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyPublicityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:510
Sets the publicity of a party. This configures who can view and join the party. Identity must be the party leader.

Parameters
- args: SetPartyPublicityCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SetPartyPublicityCommandOutput) => void
  - - (err: any, data?: SetPartyPublicityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyPublicityCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:104
Sets the publicity of a party.

This configures who can view and join the party.

Identity must be the party leader.

Parameters
- args: SetPartyPublicityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SetPartyPublicityCommandOutput>
- Defined in dist-types/PartyService.d.ts:105
Sets the publicity of a party. This configures who can view and join the party. Identity must be the party leader.

Parameters
- args: SetPartyPublicityCommandInput
- cb: (err: any, data?: SetPartyPublicityCommandOutput) => void
  - - (err: any, data?: SetPartyPublicityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyPublicityCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:106
Sets the publicity of a party. This configures who can view and join the party. Identity must be the party leader.

Parameters
- args: SetPartyPublicityCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SetPartyPublicityCommandOutput) => void
  - - (err: any, data?: SetPartyPublicityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyPublicityCommandOutput
      Returns void
Returns void

setPartyToIdle

setPartyToIdle(args: SetPartyToIdleCommandInput, options?: __HttpHandlerOptions): Promise<SetPartyToIdleCommandOutput>
setPartyToIdle(args: SetPartyToIdleCommandInput, cb: (err: any, data?: SetPartyToIdleCommandOutput) => void): void
setPartyToIdle(args: SetPartyToIdleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPartyToIdleCommandOutput) => void): void
setPartyToIdle(args: SetPartyToIdleCommandInput, options?: __HttpHandlerOptions): Promise<SetPartyToIdleCommandOutput>
setPartyToIdle(args: SetPartyToIdleCommandInput, cb: (err: any, data?: SetPartyToIdleCommandOutput) => void): void
setPartyToIdle(args: SetPartyToIdleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPartyToIdleCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:718
Sets the activity of the current identity's party to idle.

Identity must be the party leader.

Parameters
- args: SetPartyToIdleCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SetPartyToIdleCommandOutput>
- Defined in clients/client/src/PartyService.ts:722
Sets the activity of the current identity's party to idle. Identity must be the party leader.

Parameters
- args: SetPartyToIdleCommandInput
- cb: (err: any, data?: SetPartyToIdleCommandOutput) => void
  - - (err: any, data?: SetPartyToIdleCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyToIdleCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:726
Sets the activity of the current identity's party to idle. Identity must be the party leader.

Parameters
- args: SetPartyToIdleCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SetPartyToIdleCommandOutput) => void
  - - (err: any, data?: SetPartyToIdleCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyToIdleCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:185
Sets the activity of the current identity's party to idle.

Identity must be the party leader.

Parameters
- args: SetPartyToIdleCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SetPartyToIdleCommandOutput>
- Defined in dist-types/PartyService.d.ts:186
Sets the activity of the current identity's party to idle. Identity must be the party leader.

Parameters
- args: SetPartyToIdleCommandInput
- cb: (err: any, data?: SetPartyToIdleCommandOutput) => void
  - - (err: any, data?: SetPartyToIdleCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyToIdleCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:187
Sets the activity of the current identity's party to idle. Identity must be the party leader.

Parameters
- args: SetPartyToIdleCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SetPartyToIdleCommandOutput) => void
  - - (err: any, data?: SetPartyToIdleCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetPartyToIdleCommandOutput
      Returns void
Returns void

transferPartyOwnership

transferPartyOwnership(args: TransferPartyOwnershipCommandInput, options?: __HttpHandlerOptions): Promise<TransferPartyOwnershipCommandOutput>
transferPartyOwnership(args: TransferPartyOwnershipCommandInput, cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void): void
transferPartyOwnership(args: TransferPartyOwnershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void): void
transferPartyOwnership(args: TransferPartyOwnershipCommandInput, options?: __HttpHandlerOptions): Promise<TransferPartyOwnershipCommandOutput>
transferPartyOwnership(args: TransferPartyOwnershipCommandInput, cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void): void
transferPartyOwnership(args: TransferPartyOwnershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void): void

- Defined in clients/client/src/PartyService.ts:537
Transfers ownership of the party to another party member.

Identity must be the party leader.

Parameters
- args: TransferPartyOwnershipCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<TransferPartyOwnershipCommandOutput>
- Defined in clients/client/src/PartyService.ts:541
Transfers ownership of the party to another party member. Identity must be the party leader.

Parameters
- args: TransferPartyOwnershipCommandInput
- cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void
  - - (err: any, data?: TransferPartyOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferPartyOwnershipCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/PartyService.ts:545
Transfers ownership of the party to another party member. Identity must be the party leader.

Parameters
- args: TransferPartyOwnershipCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void
  - - (err: any, data?: TransferPartyOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferPartyOwnershipCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:112
Transfers ownership of the party to another party member.

Identity must be the party leader.

Parameters
- args: TransferPartyOwnershipCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<TransferPartyOwnershipCommandOutput>
- Defined in dist-types/PartyService.d.ts:113
Transfers ownership of the party to another party member. Identity must be the party leader.

Parameters
- args: TransferPartyOwnershipCommandInput
- cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void
  - - (err: any, data?: TransferPartyOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferPartyOwnershipCommandOutput
      Returns void
Returns void
- Defined in dist-types/PartyService.d.ts:114
Transfers ownership of the party to another party member. Identity must be the party leader.

Parameters
- args: TransferPartyOwnershipCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: TransferPartyOwnershipCommandOutput) => void
  - - (err: any, data?: TransferPartyOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferPartyOwnershipCommandOutput
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: PartyServiceClientConfig

Returns PartyService

Properties

Readonly config

middlewareStack

Methods

createParty

Parameters

args: CreatePartyCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CreatePartyCommandOutput>

Parameters

args: CreatePartyCommandInput

cb: (err: any, data?: CreatePartyCommandOutput) => void

Parameters

err: any

Optional data: CreatePartyCommandOutput

Returns void

Returns void

Parameters

args: CreatePartyCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CreatePartyCommandOutput) => void

Parameters

err: any

Optional data: CreatePartyCommandOutput

Returns void

Returns void

Parameters

args: CreatePartyCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CreatePartyCommandOutput>

Parameters

args: CreatePartyCommandInput

cb: (err: any, data?: CreatePartyCommandOutput) => void

Parameters

err: any

Optional data: CreatePartyCommandOutput

Returns void

Returns void

Parameters

args: CreatePartyCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CreatePartyCommandOutput) => void

Parameters

err: any

Optional data: CreatePartyCommandOutput

Returns void

Returns void

createPartyInvite

Parameters

args: CreatePartyInviteCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CreatePartyInviteCommandOutput>

Parameters

args: CreatePartyInviteCommandInput

cb: (err: any, data?: CreatePartyInviteCommandOutput) => void

Parameters

err: any

Optional data: CreatePartyInviteCommandOutput

Returns void

Returns void

Parameters

args: CreatePartyInviteCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CreatePartyInviteCommandOutput) => void

Parameters

err: any

Optional data: CreatePartyInviteCommandOutput

Returns void

Returns void