UserInformation interface
Contains information about a user.
Signature:
export interface UserInformation
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
AvatarImageUrl | readonly | string | The Url of the image used for the avatar of the user |
Level | readonly | number | The integer value of the progression level of the user in the application |
Name | readonly | string | The display name of the user |
TwitchAccount | readonly | TwitchAccountInformation | Optional information about the user's twitch account if it's linked to their Oooh account. |
Type | readonly | Enum<typeof UserType> | Which kind of user they are within the app. Note that this is not the same as their current role (ie: a creator could be acting as a user in another creators oooh) |
UserInformation.AvatarImageUrl property
The Url of the image used for the avatar of the user
Signature:
readonly AvatarImageUrl: string;
UserInformation.Level property
The integer value of the progression level of the user in the application
Signature:
readonly Level: number;
UserInformation.Name property
The display name of the user
Signature:
readonly Name: string;
UserInformation.TwitchAccount property
Optional information about the user's twitch account if it's linked to their Oooh account.
Signature:
readonly TwitchAccount: TwitchAccountInformation;
Remarks
Note that this is only available for the creator and the current user, it will not be populated for user data loaded via a leaderboard.
UserInformation.Type property
Which kind of user they are within the app. Note that this is not the same as their current role (ie: a creator could be acting as a user in another creators oooh)
Signature:
readonly Type: Enum<typeof UserType>;
Updated 7 months ago