Class Group

Represents a group on Guilded.

Example

new Group(client, rawGroup);

Hierarchy

Constructors

constructor

Properties

client id members raw

Accessors

isCached

Methods

addMember createChannel fetch removeMember

Constructors

constructor

  • Parameters

    • client: Client

      The client the group belongs to.

    • raw: {
          id: string;
      }

      The raw data of the group.

      • id: string
    • Optional cache: boolean

      Whether to cache the group.

    Returns Group

Properties

Readonly client

client: Client

Readonly id

id: string

Readonly members

members: GroupMemberManager

The manager of members that belong to the group.

Readonly raw

raw: {
    id: string;
}

Type declaration

  • id: string

Accessors

isCached

  • get isCached(): boolean

  • Whether the group is cached.

    Returns boolean

Methods

addMember

  • Add a member to the group.

    Example

    group.addMember(member);

    Parameters

    Returns Promise<void>

createChannel

  • Create a channel in the group.

    Returns

    The created channel.

    Example

    group.createChannel({ name: 'Chat', type: 'chat' });

    Parameters

    Returns Promise<Channel>

fetch

  • Fetch the group.

    Returns

    The fetched group.

    Example

    group.fetch();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the group with.

    Returns Group

removeMember

  • Remove a member from the group.

    Example

    group.removeMember(member);

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme