Class Group

Constructors

constructor

Properties

archivedAt? archivedBy? avatar? client createdAt createdBy description? emoteId? home? id name public? serverId updatedAt?

Methods

addMember removeMember

Constructors

constructor

Properties

OptionalarchivedAt

archivedAt?: Date

The date when the group was archived.

OptionalarchivedBy

archivedBy?: string

The ID of the user who archived the group.

Optionalavatar

avatar?: string

The URL of the group's avatar.

client

client: Client

createdAt

createdAt: Date

The creation date of the group.

createdBy

createdBy: string

The ID of the user who created the group.

Optionaldescription

description?: string

The description of the group.

OptionalemoteId

emoteId?: number

The ID of the group's emote.

Optionalhome

home?: boolean

Whether this group is the server's home group.

id

id: string

The ID of the group.

name

name: string

The name of the group.

Optionalpublic

public?: boolean

Whether this group is public.

serverId

serverId: string

The ID of the server which this group belongs to.

OptionalupdatedAt

updatedAt?: Date

The date when the group was updated.

Methods

addMember

  • addMember(userId: string): Promise<void>

    Add a Guilded server member to this Guilded group.

    Parameters

    • userId: string

      The ID of the Guilded user.

    Returns Promise<void>

removeMember

  • removeMember(userId: string): Promise<void>

    Add a Guilded server member to this Guilded group.

    Parameters

    • userId: string

      The ID of the Guilded user.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods