Type: UserProfile

How did we do?
Contents

Represents a user's profile.

Outline

Represents a user's profile.

Properties

allowDiscoveryByEmailAddress Description Whether or not this account can be discovered by the associated email address.
Type boolean
allowPublicVisibility Description Whether this profile is publicly visible. For a publicly visible profile, and fields which would normally have a visibility of "Games You Play" instead have a visibility of "Public".
Type boolean
avatarUrl Description The URL to the user's avatar.
Type string
canSendVerificationEmail Description Whether this account can have another verification email sent out at this time. This value will only be set for your own account.
Type boolean
descriptionHtml Description The profile description rendered as HTML.
Type string
descriptionUnsafeMarkdown Description The profile description in CommonMark, without sanitization. This value is not safe to render directly through a CommonMark renderer - you will need to strip out and remove any unsafe HTML entities as well.
Type string
displayName Description The display name of the user's profile.
Type string
emailVerificationPending Description Whether the account needs to verify the current or pending email address. This value will only be set for your own account.
Type boolean
handle Description The handle of the user account, without the leading @ prefix. You should prefix this value with @ whenever displaying it (if it's not null).
Type string
id Description The unique identifier of the account for this user profile.
Type string
locationCity Description The city the user is located in.
Type string
locationCountry Description The country the user is located in.
Type string
locationState Description The state the user is located in.
Type string
locationText Description The user's location roughly in the form "City, State, Country".
Type string
passwordResetPending Description Whether the account has a password reset request pending. This value will only be set for your own account.
Type boolean
realName Description The real name of the user's profile.
Type string
relationship Description The relationship from the current viewer to this profile. One of "self", "friend", "friend-request-sent", "friend-request-received", "other-player" or "none".
Type string