Interface UserGroup

(Source)

Hierarchy-Diagram

UML class diagram of UserGroup
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

colour? description? has_listing has_playmodes id identifier is_probationary name playmodes? short_name

Properties

Optional colour

colour?: string

Optional description

description?: GroupDescription

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

has_listing

has_listing: boolean

has_playmodes

has_playmodes: boolean

Whether this group associates GameModes with users' memberships. id number.

id

id: number

identifier

identifier: string

Unique string to identify the group.

Example

bng

is_probationary

is_probationary: boolean

Whether members of this group are considered probationary.

name

name: string

Example

Beatmap Nominators

Optional playmodes

playmodes?: null | GameMode[]

GameModes associated with this membership (null if has_playmodes is unset).

short_name

short_name: string

Short name of the group for display.

Example

BN

Settings

Member Visibility

Theme

Generated using TypeDoc