Class Group

A group in a server in Guilded

Hierarchy

Constructors

constructor

Properties

archivedAt archivedBy avatar client createdAt createdBy description emoteId id isHome isPublic name raw serverId updatedAt updatedBy

Methods

_clone _update addMember removeMember

Constructors

constructor

Properties

archivedAt

archivedAt: null | Date

archivedBy

archivedBy: null | string

avatar

avatar: string

Readonly client

client: Client

createdAt

createdAt: Date

The date this group was created at

createdBy

createdBy: string

The ID of the user who created this group

description

description: string

The description of the group

emoteId

emoteId: number

id

id: string

Identifier of this structrure

isHome

isHome: boolean

isPublic

isPublic: boolean

name

name: string

The name of the group

raw

raw: GroupPayload

Bare data of this structure

serverId

serverId: string

The ID of the server this group is in

updatedAt

updatedAt: Date

The date this group was last updated at

updatedBy

updatedBy: string

Methods

_clone

_update

addMember

  • Adds a member to the group.

    Parameters

    • memberId: string

      The ID of the member to add.

    Returns Promise<void>

    A Promise that resolves with no result on success.

removeMember

  • Removes a member from the group.

    Parameters

    • memberId: string

      The ID of the member to remove.

    Returns Promise<void>

    A Promise that resolves with no result on success.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc