Interface UserCompact

Mainly used for embedding in certain responses to save additional api lookups.

(Source)

Hierarchy-Diagram

UML class diagram of UserCompact
Legend
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property

Hierarchy

Properties

account_history? active_tournament_banner? avatar_url badges? beatmap_playcounts_count? blocks? comments_count? country? country_code cover? default_group favourite_beatmapset_count? follower_count? friends? graveyard_beatmapset_count? groups? guest_beatmapset_count? id is_active is_bot is_deleted is_online is_restricted? is_supporter last_visit? loved_beatmapset_count? mapping_follower_count? monthly_playcounts? page? pending_beatmapset_count? pm_friends_only previous_usernames? profile_colour? rank_history? ranked_beatmapset_count? replays_watched_counts? scores_best_count? scores_first_count? scores_pinned_count? scores_recent_count? statistics? statistics_rulesets support_level? unread_pm_count? user_achievements? user_preferences? username

Properties

Optional account_history

account_history?: UserAccountHistory[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional active_tournament_banner

active_tournament_banner?: null | UserProfileBanner

May be additionally included in the response. Relevant endpoints should list them if applicable.

null if the user has no active tournament banner.

This is included in a UserEndpointGet object.

avatar_url

avatar_url: string

Url of user's avatar.

Optional badges

badges?: UserBadge[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional beatmap_playcounts_count

beatmap_playcounts_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointMe object.

Optional blocks

blocks?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

Optional comments_count

comments_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional country

country?: UserCompactCountry

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a User object.

country_code

country_code: string

Two-letter code representing user's country.

Optional cover

cover?: UserCompactCover

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a User object.

default_group

default_group: string

Identifier of the default group the user belongs to.

Optional favourite_beatmapset_count

favourite_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional follower_count

follower_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional friends

friends?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

Optional graveyard_beatmapset_count

graveyard_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional groups

groups?: UserGroup[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional guest_beatmapset_count

guest_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

id

id: number

Unique identifier for user.

is_active

is_active: boolean

Has this account been active in the last x months?

is_bot

is_bot: boolean

Is this a bot account?

is_deleted

is_deleted: boolean

Account was deleted.

is_online

is_online: boolean

Is the user currently online? (either on lazer or the new website).

Optional is_restricted

is_restricted?: boolean

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a User object if this is the currently authenticated user.

This is included in a UserEndpointMe object.

is_supporter

is_supporter: boolean

Does this user have supporter?

Optional last_visit

last_visit?: null | string

Last access time. null if the user hides online presence.

This is included in a UserEndpointGet/UserEndpointSearchUser object.

Optional loved_beatmapset_count

loved_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional mapping_follower_count

mapping_follower_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional monthly_playcounts

monthly_playcounts?: UserMonthlyPlaycount[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional page

page?: UserCompactPage

May be additionally included in the response. Relevant endpoints should list them if applicable.

If the user has never edited their page (never supported osu!) this key will not be undefined.

This is included in a UserEndpointGet object.

Optional pending_beatmapset_count

pending_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

pm_friends_only

pm_friends_only: boolean

Whether or not the user allows PM from other than friends.

Optional previous_usernames

previous_usernames?: string[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional profile_colour

profile_colour?: null | string

Colour of username/profile highlight.

This is included in a UserEndpointGet/UserEndpointSearchUser object.

Optional rank_history

rank_history?: UserRankHistory

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional ranked_beatmapset_count

ranked_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional replays_watched_counts

replays_watched_counts?: UserReplaysWatchedCount[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_best_count

scores_best_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_first_count

scores_first_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_pinned_count

scores_pinned_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_recent_count

scores_recent_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional statistics

statistics?: UserStatistics

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

statistics_rulesets

statistics_rulesets: UserStatisticsRulesets

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointMe object.

Optional support_level

support_level?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional unread_pm_count

unread_pm_count?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

Optional user_achievements

user_achievements?: UserAchievement[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional user_preferences

user_preferences?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

username

username: string

User's display name.

Settings

Member Visibility

Theme

Generated using TypeDoc