Options
All
  • Public
  • Public/Protected
  • All
Menu

An identity profile.

Index

Properties

accountNumber

accountNumber: number | undefined

Identity profile account number (#1234). These are assigned in addition to an identity's display name in order to allow multiple identities to have the same display name while still providing a unique handle. These are unique to each display name; you can have multiple accounts with different display names and the same account number.

avatarUrl

avatarUrl: string | undefined

The URL of this identity's avatar image.

bio

bio: string | undefined

Detailed information about a profile.

Optional devState

devState: IdentityDevState | string

The state of the given identity's developer status.

displayName

displayName: string | undefined

Represent a resource's readable display name.

external

external: IdentityExternalLinks | undefined

External links for an identity.

followerCount

followerCount: number | undefined

Unsigned 32 bit integer.

following

following: boolean | undefined

Whether or not the requestee's identity is following this identity.

followingCount

followingCount: number | undefined

Unsigned 32 bit integer.

games

games: GameStatSummary[] | undefined

A list of game statistic summaries.

groups

groups: IdentityGroup[] | undefined

A list of groups that the given identity is in.

identityId

identityId: string | undefined

A universally unique identifier.

isAdmin

isAdmin: boolean | undefined

Whether or not this identity is an admin.

isFollowingMe

isFollowingMe: boolean | undefined

Whether or not this identity following the requestee's identity.

Optional isGameLinked

isGameLinked: undefined | false | true

Whether or not this game user has been linked through the Rivet dashboard.

isMutualFollowing

isMutualFollowing: boolean | undefined

Whether or not this identity is both followng and is followed by the requestee's identity.

isRegistered

isRegistered: boolean | undefined

Whether or not this identity is registered with a linked account.

joinTs

joinTs: Date | undefined

RFC3339 timestamp.

linkedAccounts

linkedAccounts: IdentityLinkedAccount[] | undefined

A list of an identity's linked accounts.

Optional party

A party summary.

Optional presence

Information about the identity's current status, party, and active game.