Interface Group

A group in the server.

Hierarchy

  • Group

Properties

avatar_url? create_time? creator_id? description? edge_count? id? lang_tag? max_count? metadata? name? open? update_time?

Properties

Optional avatar_url

avatar_url?: string

A URL for an avatar image.

Optional create_time

create_time?: string

The UNIX time when the group was created.

Optional creator_id

creator_id?: string

The id of the user who created the group.

Optional description

description?: string

A description for the group.

Optional edge_count

edge_count?: number

The current count of all members in the group.

Optional id

id?: string

The id of a group.

Optional lang_tag

lang_tag?: string

The language expected to be a tag which follows the BCP-47 spec.

Optional max_count

max_count?: number

The maximum number of members allowed.

Optional metadata

metadata?: {}

Additional information stored as a JSON object.

Type declaration

    Optional name

    name?: string

    The unique name of the group.

    Optional open

    open?: boolean

    Anyone can join open groups, otherwise only admins can accept members.

    Optional update_time

    update_time?: string

    The UNIX time when the group was last updated.

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc