guilded.ts/dist/structures/Group.d.ts

A powerful NPM module that allows you to easily interact with the Guilded API.

import { Base } from './Base';
import { Client } from './Client';
import { GroupMemberManager } from '../managers/group/GroupMemberManager';
import { FetchOptions } from '../managers/BaseManager';
import { ServerMember } from './server/ServerMember';
import { APIChannelPayload } from 'guilded-api-typings';
/**
 * Represents a group on Guilded.
 * @example new Group(client, rawGroup);
 */
export declare class Group extends Base {
    readonly raw: {
        id: string;
    };
    /** The manager of members that belong to the group. */
    readonly members: GroupMemberManager;
    /**
     * @param client The client the group belongs to.
     * @param raw The raw data of the group.
     * @param cache Whether to cache the group.
     */
    constructor(client: Client, raw: {
        id: string;
    }, cache?: boolean);
    /** Whether the group is cached. */
    get isCached(): boolean;
    /**
     * Fetch the group.
     * @param options The options to fetch the group with.
     * @returns The fetched group.
     * @example group.fetch();
     */
    fetch(options?: FetchOptions): this;
    /**
     * Add a member to the group.
     * @param member The member to add.
     * @example group.addMember(member);
     */
    addMember(member: string | ServerMember): Promise<void>;
    /**
     * Remove a member from the group.
     * @param member The member to remove.
     * @example group.removeMember(member);
     */
    removeMember(member: string | ServerMember): Promise<void>;
    /**
     * Create a channel in the group.
     * @param payload The payload of the channel.
     * @returns The created channel.
     * @example group.createChannel({ name: 'Chat', type: 'chat' });
     */
    createChannel(payload: Omit<APIChannelPayload, 'groupId'>): Promise<import("..").Channel>;
}
//# sourceMappingURL=Group.d.ts.map