IdentityService | @rivet-gg/identity

Hierarchy

IdentityServiceClient
- IdentityService

Implements

Client<ServiceInputTypes, ServiceOutputTypes, IdentityServiceClientResolvedConfig>

Index

Constructors

constructor

Properties

Constructors

constructor

new IdentityService(configuration: IdentityServiceClientConfig): IdentityService

Inherited from IdentityServiceClient.constructor

Overrides Client.__constructor
- Defined in clients/client/src/IdentityServiceClient.ts:361
Parameters
- configuration: IdentityServiceClientConfig
Returns IdentityService

Properties

Readonly config

config: IdentityServiceClientResolvedConfig

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

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

cancelGameLink

cancelGameLink(args: CancelGameLinkCommandInput, options?: __HttpHandlerOptions): Promise<CancelGameLinkCommandOutput>
cancelGameLink(args: CancelGameLinkCommandInput, cb: (err: any, data?: CancelGameLinkCommandOutput) => void): void
cancelGameLink(args: CancelGameLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelGameLinkCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:144
Cancels a game link. It can no longer be used to link after cancellation.

Parameters
- args: CancelGameLinkCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CancelGameLinkCommandOutput>
- Defined in clients/client/src/IdentityService.ts:148
Cancels a game link. It can no longer be used to link after cancellation.

Parameters
- args: CancelGameLinkCommandInput
- cb: (err: any, data?: CancelGameLinkCommandOutput) => void
  - - (err: any, data?: CancelGameLinkCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CancelGameLinkCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:152
Cancels a game link. It can no longer be used to link after cancellation.

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

completeGameLink

completeGameLink(args: CompleteGameLinkCommandInput, options?: __HttpHandlerOptions): Promise<CompleteGameLinkCommandOutput>
completeGameLink(args: CompleteGameLinkCommandInput, cb: (err: any, data?: CompleteGameLinkCommandOutput) => void): void
completeGameLink(args: CompleteGameLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteGameLinkCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:177
Completes a game link process and returns whether or not the link is valid.

Parameters
- args: CompleteGameLinkCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CompleteGameLinkCommandOutput>
- Defined in clients/client/src/IdentityService.ts:181
Completes a game link process and returns whether or not the link is valid.

Parameters
- args: CompleteGameLinkCommandInput
- cb: (err: any, data?: CompleteGameLinkCommandOutput) => void
  - - (err: any, data?: CompleteGameLinkCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CompleteGameLinkCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:185
Completes a game link process and returns whether or not the link is valid.

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

completeIdentityAvatarUpload

completeIdentityAvatarUpload(args: CompleteIdentityAvatarUploadCommandInput, options?: __HttpHandlerOptions): Promise<CompleteIdentityAvatarUploadCommandOutput>
completeIdentityAvatarUpload(args: CompleteIdentityAvatarUploadCommandInput, cb: (err: any, data?: CompleteIdentityAvatarUploadCommandOutput) => void): void
completeIdentityAvatarUpload(args: CompleteIdentityAvatarUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteIdentityAvatarUploadCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:210
Completes an avatar image upload. Must be called after the file upload process completes.

Parameters
- args: CompleteIdentityAvatarUploadCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CompleteIdentityAvatarUploadCommandOutput>
- Defined in clients/client/src/IdentityService.ts:214
Completes an avatar image upload. Must be called after the file upload process completes.

Parameters
- args: CompleteIdentityAvatarUploadCommandInput
- cb: (err: any, data?: CompleteIdentityAvatarUploadCommandOutput) => void
  - - (err: any, data?: CompleteIdentityAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CompleteIdentityAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:218
Completes an avatar image upload. Must be called after the file upload process completes.

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

destroy

destroy(): void

Inherited from IdentityServiceClient.destroy

Overrides Client.destroy
- Defined in clients/client/src/IdentityServiceClient.ts:424
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

followIdentity

followIdentity(args: FollowIdentityCommandInput, options?: __HttpHandlerOptions): Promise<FollowIdentityCommandOutput>
followIdentity(args: FollowIdentityCommandInput, cb: (err: any, data?: FollowIdentityCommandOutput) => void): void
followIdentity(args: FollowIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FollowIdentityCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:246
Follows the given identity.

In order for identities to be "friends", the other identity has to also follow this identity.

Parameters
- args: FollowIdentityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<FollowIdentityCommandOutput>
- Defined in clients/client/src/IdentityService.ts:250
Follows the given identity. In order for identities to be "friends", the other identity has to also follow this identity.

Parameters
- args: FollowIdentityCommandInput
- cb: (err: any, data?: FollowIdentityCommandOutput) => void
  - - (err: any, data?: FollowIdentityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: FollowIdentityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:254
Follows the given identity. In order for identities to be "friends", the other identity has to also follow this identity.

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

getGameLink

getGameLink(args: GetGameLinkCommandInput, options?: __HttpHandlerOptions): Promise<GetGameLinkCommandOutput>
getGameLink(args: GetGameLinkCommandInput, cb: (err: any, data?: GetGameLinkCommandOutput) => void): void
getGameLink(args: GetGameLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGameLinkCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:282
Returns the current status of a linking process.

Once status is complete, the identity's profile should be fetched again since they may have switched accounts.

Parameters
- args: GetGameLinkCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGameLinkCommandOutput>
- Defined in clients/client/src/IdentityService.ts:286
Returns the current status of a linking process. Once status is complete, the identity's profile should be fetched again since they may have switched accounts.

Parameters
- args: GetGameLinkCommandInput
- cb: (err: any, data?: GetGameLinkCommandOutput) => void
  - - (err: any, data?: GetGameLinkCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGameLinkCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:290
Returns the current status of a linking process. Once status is complete, the identity's profile should be fetched again since they may have switched accounts.

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

getIdentityHandles

getIdentityHandles(args: GetIdentityHandlesCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityHandlesCommandOutput>
getIdentityHandles(args: GetIdentityHandlesCommandInput, cb: (err: any, data?: GetIdentityHandlesCommandOutput) => void): void
getIdentityHandles(args: GetIdentityHandlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityHandlesCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:315
Fetches a list of identity handles.

Parameters
- args: GetIdentityHandlesCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetIdentityHandlesCommandOutput>
- Defined in clients/client/src/IdentityService.ts:319
Fetches a list of identity handles.

Parameters
- args: GetIdentityHandlesCommandInput
- cb: (err: any, data?: GetIdentityHandlesCommandOutput) => void
  - - (err: any, data?: GetIdentityHandlesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetIdentityHandlesCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:323
Fetches a list of identity handles.

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

getIdentityProfile

getIdentityProfile(args: GetIdentityProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityProfileCommandOutput>
getIdentityProfile(args: GetIdentityProfileCommandInput, cb: (err: any, data?: GetIdentityProfileCommandOutput) => void): void
getIdentityProfile(args: GetIdentityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityProfileCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:348
Fetches an identity profile.

Parameters
- args: GetIdentityProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetIdentityProfileCommandOutput>
- Defined in clients/client/src/IdentityService.ts:352
Fetches an identity profile.

Parameters
- args: GetIdentityProfileCommandInput
- cb: (err: any, data?: GetIdentityProfileCommandOutput) => void
  - - (err: any, data?: GetIdentityProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetIdentityProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:356
Fetches an identity profile.

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

getIdentitySelfProfile

getIdentitySelfProfile(args: GetIdentitySelfProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentitySelfProfileCommandOutput>
getIdentitySelfProfile(args: GetIdentitySelfProfileCommandInput, cb: (err: any, data?: GetIdentitySelfProfileCommandOutput) => void): void
getIdentitySelfProfile(args: GetIdentitySelfProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentitySelfProfileCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:381
Fetches the current identity's profile.

Parameters
- args: GetIdentitySelfProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetIdentitySelfProfileCommandOutput>
- Defined in clients/client/src/IdentityService.ts:385
Fetches the current identity's profile.

Parameters
- args: GetIdentitySelfProfileCommandInput
- cb: (err: any, data?: GetIdentitySelfProfileCommandOutput) => void
  - - (err: any, data?: GetIdentitySelfProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetIdentitySelfProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:389
Fetches the current identity's profile.

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

getIdentitySummaries

getIdentitySummaries(args: GetIdentitySummariesCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentitySummariesCommandOutput>
getIdentitySummaries(args: GetIdentitySummariesCommandInput, cb: (err: any, data?: GetIdentitySummariesCommandOutput) => void): void
getIdentitySummaries(args: GetIdentitySummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentitySummariesCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:414
Fetches a list of identity summaries.

Parameters
- args: GetIdentitySummariesCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetIdentitySummariesCommandOutput>
- Defined in clients/client/src/IdentityService.ts:418
Fetches a list of identity summaries.

Parameters
- args: GetIdentitySummariesCommandInput
- cb: (err: any, data?: GetIdentitySummariesCommandOutput) => void
  - - (err: any, data?: GetIdentitySummariesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetIdentitySummariesCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:422
Fetches a list of identity summaries.

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

listActivities

listActivities(args: ListActivitiesCommandInput, options?: __HttpHandlerOptions): Promise<ListActivitiesCommandOutput>
listActivities(args: ListActivitiesCommandInput, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void
listActivities(args: ListActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:447
Returns an overview of all players currently online or in game.

Parameters
- args: ListActivitiesCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListActivitiesCommandOutput>
- Defined in clients/client/src/IdentityService.ts:451
Returns an overview of all players currently online or in game.

Parameters
- args: ListActivitiesCommandInput
- cb: (err: any, data?: ListActivitiesCommandOutput) => void
  - - (err: any, data?: ListActivitiesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListActivitiesCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:455
Returns an overview of all players currently online or in game.

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

listFollowers

listFollowers(args: ListFollowersCommandInput, options?: __HttpHandlerOptions): Promise<ListFollowersCommandOutput>
listFollowers(args: ListFollowersCommandInput, cb: (err: any, data?: ListFollowersCommandOutput) => void): void
listFollowers(args: ListFollowersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFollowersCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:477
Parameters
- args: ListFollowersCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListFollowersCommandOutput>
- Defined in clients/client/src/IdentityService.ts:481
Parameters
- args: ListFollowersCommandInput
- cb: (err: any, data?: ListFollowersCommandOutput) => void
  - - (err: any, data?: ListFollowersCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListFollowersCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:485
Parameters
- args: ListFollowersCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListFollowersCommandOutput) => void
  - - (err: any, data?: ListFollowersCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListFollowersCommandOutput
      Returns void
Returns void

listFollowing

listFollowing(args: ListFollowingCommandInput, options?: __HttpHandlerOptions): Promise<ListFollowingCommandOutput>
listFollowing(args: ListFollowingCommandInput, cb: (err: any, data?: ListFollowingCommandOutput) => void): void
listFollowing(args: ListFollowingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFollowingCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:507
Parameters
- args: ListFollowingCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListFollowingCommandOutput>
- Defined in clients/client/src/IdentityService.ts:511
Parameters
- args: ListFollowingCommandInput
- cb: (err: any, data?: ListFollowingCommandOutput) => void
  - - (err: any, data?: ListFollowingCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListFollowingCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:515
Parameters
- args: ListFollowingCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListFollowingCommandOutput) => void
  - - (err: any, data?: ListFollowingCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListFollowingCommandOutput
      Returns void
Returns void

listFriends

listFriends(args: ListFriendsCommandInput, options?: __HttpHandlerOptions): Promise<ListFriendsCommandOutput>
listFriends(args: ListFriendsCommandInput, cb: (err: any, data?: ListFriendsCommandOutput) => void): void
listFriends(args: ListFriendsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFriendsCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:537
Parameters
- args: ListFriendsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListFriendsCommandOutput>
- Defined in clients/client/src/IdentityService.ts:541
Parameters
- args: ListFriendsCommandInput
- cb: (err: any, data?: ListFriendsCommandOutput) => void
  - - (err: any, data?: ListFriendsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListFriendsCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:545
Parameters
- args: ListFriendsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListFriendsCommandOutput) => void
  - - (err: any, data?: ListFriendsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListFriendsCommandOutput
      Returns void
Returns void

listMutualFriends

listMutualFriends(args: ListMutualFriendsCommandInput, options?: __HttpHandlerOptions): Promise<ListMutualFriendsCommandOutput>
listMutualFriends(args: ListMutualFriendsCommandInput, cb: (err: any, data?: ListMutualFriendsCommandOutput) => void): void
listMutualFriends(args: ListMutualFriendsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMutualFriendsCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:567
Parameters
- args: ListMutualFriendsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListMutualFriendsCommandOutput>
- Defined in clients/client/src/IdentityService.ts:571
Parameters
- args: ListMutualFriendsCommandInput
- cb: (err: any, data?: ListMutualFriendsCommandOutput) => void
  - - (err: any, data?: ListMutualFriendsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListMutualFriendsCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:575
Parameters
- args: ListMutualFriendsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListMutualFriendsCommandOutput) => void
  - - (err: any, data?: ListMutualFriendsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListMutualFriendsCommandOutput
      Returns void
Returns void

prepareGameLink

prepareGameLink(args: PrepareGameLinkCommandInput, options?: __HttpHandlerOptions): Promise<PrepareGameLinkCommandOutput>
prepareGameLink(args: PrepareGameLinkCommandInput, cb: (err: any, data?: PrepareGameLinkCommandOutput) => void): void
prepareGameLink(args: PrepareGameLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareGameLinkCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:617
Begins the process for linking an identity with the Rivet Hub.

Importance of Linking Identities

When an identity is created via rivet.api.identity#SetupIdentity, the identity is temporary and is not shared with other games the user plays.

In order to make the identity permanent and synchronize the identity with other games, the identity must be linked with the hub.

Linking Process

The linking process works by opening identity_link_url in a browser then polling rivet.api.identity#GetGameLink to wait for it to complete.

This is designed to be as flexible as possible so identity_link_url can be opened on any device. For example, when playing a console game, the user can scan a QR code for identity_link_url to authenticate on their phone.

Parameters
- args: PrepareGameLinkCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PrepareGameLinkCommandOutput>
- Defined in clients/client/src/IdentityService.ts:621
Begins the process for linking an identity with the Rivet Hub.

Importance of Linking Identities

When an identity is created via rivet.api.identity#SetupIdentity, the identity is temporary and is not shared with other games the user plays. In order to make the identity permanent and synchronize the identity with other games, the identity must be linked with the hub.

Linking Process

The linking process works by opening identity_link_url in a browser then polling rivet.api.identity#GetGameLink to wait for it to complete. This is designed to be as flexible as possible so identity_link_url can be opened on any device. For example, when playing a console game, the user can scan a QR code for identity_link_url to authenticate on their phone.

Parameters
- args: PrepareGameLinkCommandInput
- cb: (err: any, data?: PrepareGameLinkCommandOutput) => void
  - - (err: any, data?: PrepareGameLinkCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PrepareGameLinkCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:625
Begins the process for linking an identity with the Rivet Hub.

Importance of Linking Identities

When an identity is created via rivet.api.identity#SetupIdentity, the identity is temporary and is not shared with other games the user plays. In order to make the identity permanent and synchronize the identity with other games, the identity must be linked with the hub.

Linking Process

The linking process works by opening identity_link_url in a browser then polling rivet.api.identity#GetGameLink to wait for it to complete. This is designed to be as flexible as possible so identity_link_url can be opened on any device. For example, when playing a console game, the user can scan a QR code for identity_link_url to authenticate on their phone.

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

prepareIdentityAvatarUpload

prepareIdentityAvatarUpload(args: PrepareIdentityAvatarUploadCommandInput, options?: __HttpHandlerOptions): Promise<PrepareIdentityAvatarUploadCommandOutput>
prepareIdentityAvatarUpload(args: PrepareIdentityAvatarUploadCommandInput, cb: (err: any, data?: PrepareIdentityAvatarUploadCommandOutput) => void): void
prepareIdentityAvatarUpload(args: PrepareIdentityAvatarUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareIdentityAvatarUploadCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:652
Prepares an avatar image upload.

Complete upload with rivet.api.identity#CompleteIdentityAvatarUpload.

Parameters
- args: PrepareIdentityAvatarUploadCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PrepareIdentityAvatarUploadCommandOutput>
- Defined in clients/client/src/IdentityService.ts:656
Prepares an avatar image upload. Complete upload with rivet.api.identity#CompleteIdentityAvatarUpload.

Parameters
- args: PrepareIdentityAvatarUploadCommandInput
- cb: (err: any, data?: PrepareIdentityAvatarUploadCommandOutput) => void
  - - (err: any, data?: PrepareIdentityAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PrepareIdentityAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:660
Prepares an avatar image upload. Complete upload with rivet.api.identity#CompleteIdentityAvatarUpload.

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

removeIdentityGameActivity

removeIdentityGameActivity(args: RemoveIdentityGameActivityCommandInput, options?: __HttpHandlerOptions): Promise<RemoveIdentityGameActivityCommandOutput>
removeIdentityGameActivity(args: RemoveIdentityGameActivityCommandInput, cb: (err: any, data?: RemoveIdentityGameActivityCommandOutput) => void): void
removeIdentityGameActivity(args: RemoveIdentityGameActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveIdentityGameActivityCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:685
Removes the current identity's game activity.

Parameters
- args: RemoveIdentityGameActivityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RemoveIdentityGameActivityCommandOutput>
- Defined in clients/client/src/IdentityService.ts:689
Removes the current identity's game activity.

Parameters
- args: RemoveIdentityGameActivityCommandInput
- cb: (err: any, data?: RemoveIdentityGameActivityCommandOutput) => void
  - - (err: any, data?: RemoveIdentityGameActivityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RemoveIdentityGameActivityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:693
Removes the current identity's game activity.

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

reportIdentity

reportIdentity(args: ReportIdentityCommandInput, options?: __HttpHandlerOptions): Promise<ReportIdentityCommandOutput>
reportIdentity(args: ReportIdentityCommandInput, cb: (err: any, data?: ReportIdentityCommandOutput) => void): void
reportIdentity(args: ReportIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReportIdentityCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:718
Creates an abuse report for an identity.

Parameters
- args: ReportIdentityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ReportIdentityCommandOutput>
- Defined in clients/client/src/IdentityService.ts:722
Creates an abuse report for an identity.

Parameters
- args: ReportIdentityCommandInput
- cb: (err: any, data?: ReportIdentityCommandOutput) => void
  - - (err: any, data?: ReportIdentityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ReportIdentityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:726
Creates an abuse report for an identity.

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

searchIdentities

searchIdentities(args: SearchIdentitiesCommandInput, options?: __HttpHandlerOptions): Promise<SearchIdentitiesCommandOutput>
searchIdentities(args: SearchIdentitiesCommandInput, cb: (err: any, data?: SearchIdentitiesCommandOutput) => void): void
searchIdentities(args: SearchIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchIdentitiesCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:751
Fuzzy search for identities.

Parameters
- args: SearchIdentitiesCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SearchIdentitiesCommandOutput>
- Defined in clients/client/src/IdentityService.ts:755
Fuzzy search for identities.

Parameters
- args: SearchIdentitiesCommandInput
- cb: (err: any, data?: SearchIdentitiesCommandOutput) => void
  - - (err: any, data?: SearchIdentitiesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SearchIdentitiesCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:759
Fuzzy search for identities.

Parameters
- args: SearchIdentitiesCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SearchIdentitiesCommandOutput) => void
  - - (err: any, data?: SearchIdentitiesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SearchIdentitiesCommandOutput
      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 IdentityServiceClient.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 IdentityServiceClient.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 IdentityServiceClient.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

setIdentityGameActivity

setIdentityGameActivity(args: SetIdentityGameActivityCommandInput, options?: __HttpHandlerOptions): Promise<SetIdentityGameActivityCommandOutput>
setIdentityGameActivity(args: SetIdentityGameActivityCommandInput, cb: (err: any, data?: SetIdentityGameActivityCommandOutput) => void): void
setIdentityGameActivity(args: SetIdentityGameActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityGameActivityCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:786
Sets the current identity's game activity.

This activity will automatically be removed when the identity goes offline.

Parameters
- args: SetIdentityGameActivityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SetIdentityGameActivityCommandOutput>
- Defined in clients/client/src/IdentityService.ts:790
Sets the current identity's game activity. This activity will automatically be removed when the identity goes offline.

Parameters
- args: SetIdentityGameActivityCommandInput
- cb: (err: any, data?: SetIdentityGameActivityCommandOutput) => void
  - - (err: any, data?: SetIdentityGameActivityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetIdentityGameActivityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:794
Sets the current identity's game activity. This activity will automatically be removed when the identity goes offline.

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

setupIdentity

setupIdentity(args: SetupIdentityCommandInput, options?: __HttpHandlerOptions): Promise<SetupIdentityCommandOutput>
setupIdentity(args: SetupIdentityCommandInput, cb: (err: any, data?: SetupIdentityCommandOutput) => void): void
setupIdentity(args: SetupIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetupIdentityCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:838
Gets or creates an identity.

Passing an existing identity token in the body refreshes the token.

Temporary Accounts

Until the identity is linked with the Rivet Hub (see rivet.api.identity#PrepareGameLink), this identity will be temporary but still behave like all other identities.

This is intended to allow users to play the game without signing up while still having the benefits of having an account. When they are ready to save their account, they should be instructed to link their account (see rivet.api.identity#PrepareGameLink).

Storing Token

identity_token should be stored in some form of persistent storage. The token should be read from storage and passed to rivet.api.identity#SetupIdentity every time the client starts.

Parameters
- args: SetupIdentityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SetupIdentityCommandOutput>
- Defined in clients/client/src/IdentityService.ts:842
Gets or creates an identity. Passing an existing identity token in the body refreshes the token.

Temporary Accounts

Until the identity is linked with the Rivet Hub (see rivet.api.identity#PrepareGameLink), this identity will be temporary but still behave like all other identities. This is intended to allow users to play the game without signing up while still having the benefits of having an account. When they are ready to save their account, they should be instructed to link their account (see rivet.api.identity#PrepareGameLink).

Storing Token

identity_token should be stored in some form of persistent storage. The token should be read from storage and passed to rivet.api.identity#SetupIdentity every time the client starts.

Parameters
- args: SetupIdentityCommandInput
- cb: (err: any, data?: SetupIdentityCommandOutput) => void
  - - (err: any, data?: SetupIdentityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SetupIdentityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:846
Gets or creates an identity. Passing an existing identity token in the body refreshes the token.

Temporary Accounts

Until the identity is linked with the Rivet Hub (see rivet.api.identity#PrepareGameLink), this identity will be temporary but still behave like all other identities. This is intended to allow users to play the game without signing up while still having the benefits of having an account. When they are ready to save their account, they should be instructed to link their account (see rivet.api.identity#PrepareGameLink).

Storing Token

identity_token should be stored in some form of persistent storage. The token should be read from storage and passed to rivet.api.identity#SetupIdentity every time the client starts.

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

signupForBeta

signupForBeta(args: SignupForBetaCommandInput, options?: __HttpHandlerOptions): Promise<SignupForBetaCommandOutput>
signupForBeta(args: SignupForBetaCommandInput, cb: (err: any, data?: SignupForBetaCommandOutput) => void): void
signupForBeta(args: SignupForBetaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignupForBetaCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:871
Submits a beta signup form.

Parameters
- args: SignupForBetaCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SignupForBetaCommandOutput>
- Defined in clients/client/src/IdentityService.ts:875
Submits a beta signup form.

Parameters
- args: SignupForBetaCommandInput
- cb: (err: any, data?: SignupForBetaCommandOutput) => void
  - - (err: any, data?: SignupForBetaCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SignupForBetaCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:879
Submits a beta signup form.

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

unfollowIdentity

unfollowIdentity(args: UnfollowIdentityCommandInput, options?: __HttpHandlerOptions): Promise<UnfollowIdentityCommandOutput>
unfollowIdentity(args: UnfollowIdentityCommandInput, cb: (err: any, data?: UnfollowIdentityCommandOutput) => void): void
unfollowIdentity(args: UnfollowIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnfollowIdentityCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:904
Unfollows the given identity.

Parameters
- args: UnfollowIdentityCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UnfollowIdentityCommandOutput>
- Defined in clients/client/src/IdentityService.ts:908
Unfollows the given identity.

Parameters
- args: UnfollowIdentityCommandInput
- cb: (err: any, data?: UnfollowIdentityCommandOutput) => void
  - - (err: any, data?: UnfollowIdentityCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UnfollowIdentityCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:912
Unfollows the given identity.

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

updateIdentityProfile

updateIdentityProfile(args: UpdateIdentityProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIdentityProfileCommandOutput>
updateIdentityProfile(args: UpdateIdentityProfileCommandInput, cb: (err: any, data?: UpdateIdentityProfileCommandOutput) => void): void
updateIdentityProfile(args: UpdateIdentityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProfileCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:937
Updates profile of the current identity.

Parameters
- args: UpdateIdentityProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UpdateIdentityProfileCommandOutput>
- Defined in clients/client/src/IdentityService.ts:941
Updates profile of the current identity.

Parameters
- args: UpdateIdentityProfileCommandInput
- cb: (err: any, data?: UpdateIdentityProfileCommandOutput) => void
  - - (err: any, data?: UpdateIdentityProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UpdateIdentityProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:945
Updates profile of the current identity.

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

updateIdentityStatus

updateIdentityStatus(args: UpdateIdentityStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIdentityStatusCommandOutput>
updateIdentityStatus(args: UpdateIdentityStatusCommandInput, cb: (err: any, data?: UpdateIdentityStatusCommandOutput) => void): void
updateIdentityStatus(args: UpdateIdentityStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityStatusCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:970
Updates the current identity's status.

Parameters
- args: UpdateIdentityStatusCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UpdateIdentityStatusCommandOutput>
- Defined in clients/client/src/IdentityService.ts:974
Updates the current identity's status.

Parameters
- args: UpdateIdentityStatusCommandInput
- cb: (err: any, data?: UpdateIdentityStatusCommandOutput) => void
  - - (err: any, data?: UpdateIdentityStatusCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UpdateIdentityStatusCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:978
Updates the current identity's status.

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

validateIdentityProfile

validateIdentityProfile(args: ValidateIdentityProfileCommandInput, options?: __HttpHandlerOptions): Promise<ValidateIdentityProfileCommandOutput>
validateIdentityProfile(args: ValidateIdentityProfileCommandInput, cb: (err: any, data?: ValidateIdentityProfileCommandOutput) => void): void
validateIdentityProfile(args: ValidateIdentityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateIdentityProfileCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:1005
Validate contents of identity profile.

Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateIdentityProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ValidateIdentityProfileCommandOutput>
- Defined in clients/client/src/IdentityService.ts:1009
Validate contents of identity profile. Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateIdentityProfileCommandInput
- cb: (err: any, data?: ValidateIdentityProfileCommandOutput) => void
  - - (err: any, data?: ValidateIdentityProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ValidateIdentityProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:1013
Validate contents of identity profile. Use to provide immediate feedback on profile changes before committing them.

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

watchEvents

watchEvents(args: WatchEventsCommandInput, options?: __HttpHandlerOptions): Promise<WatchEventsCommandOutput>
watchEvents(args: WatchEventsCommandInput, cb: (err: any, data?: WatchEventsCommandOutput) => void): void
watchEvents(args: WatchEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: WatchEventsCommandOutput) => void): void

- Defined in clients/client/src/IdentityService.ts:1038
Returns all events relative to the current identity.

Parameters
- args: WatchEventsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<WatchEventsCommandOutput>
- Defined in clients/client/src/IdentityService.ts:1042
Returns all events relative to the current identity.

Parameters
- args: WatchEventsCommandInput
- cb: (err: any, data?: WatchEventsCommandOutput) => void
  - - (err: any, data?: WatchEventsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: WatchEventsCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/IdentityService.ts:1046
Returns all events relative to the current identity.

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: IdentityServiceClientConfig

Returns IdentityService

Properties

Readonly config

middlewareStack

Methods

cancelGameLink

Parameters

args: CancelGameLinkCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CancelGameLinkCommandOutput>

Parameters

args: CancelGameLinkCommandInput

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

Parameters

err: any

Optional data: CancelGameLinkCommandOutput

Returns void

Returns void

Parameters

args: CancelGameLinkCommandInput

options: __HttpHandlerOptions

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

Parameters

err: any

Optional data: CancelGameLinkCommandOutput

Returns void

Returns void

completeGameLink

Parameters

args: CompleteGameLinkCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CompleteGameLinkCommandOutput>

Parameters

args: CompleteGameLinkCommandInput

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

Parameters

err: any

Optional data: CompleteGameLinkCommandOutput

Returns void

Returns void

Parameters

args: CompleteGameLinkCommandInput

options: __HttpHandlerOptions

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

Parameters

err: any

Optional data: CompleteGameLinkCommandOutput

Returns void

Returns void

completeIdentityAvatarUpload

Parameters

args: CompleteIdentityAvatarUploadCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CompleteIdentityAvatarUploadCommandOutput>

Parameters

args: CompleteIdentityAvatarUploadCommandInput

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

Parameters

err: any

Optional data: CompleteIdentityAvatarUploadCommandOutput

Returns void

Returns void

Parameters

args: CompleteIdentityAvatarUploadCommandInput

options: __HttpHandlerOptions

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

Parameters

err: any

Optional data: CompleteIdentityAvatarUploadCommandOutput

Returns void