gluon
    Preparing search index...

    Class Guild

    Represents a Discord guild.

    https://discord.com/developers/docs/resources/guild

    Implements

    • Guild
    Index

    Constructors

    constructor

    Accessors

    _cacheOptions _originalIconHash auditLogs channels defaultMessageNotifications description displayIconURL emojis explicitContentFilter id invites joinedAt memberCount members mfaLevel name nsfwLevel owner ownerId preferredLocale premiumProgressBarEnabled premiumSubscriptionCount premiumTier roles rulesChannel rulesChannelId scheduledEvents systemChannel systemChannelFlags systemChannelId unavailable verificationLevel voiceStates

    Methods

    _decrementMemberCount _incrementMemberCount _intervalCallback [custom] ban calculateMemberCacheCount calculateMessageCacheCount fetchAuditLogs fetchBan fetchChannels fetchInvites kick leave me removeMemberRole toJSON toString unban createWebhook deleteWebhook fetchWebhook getIcon modifyWebhook postWebhook shouldCache

    Constructors

    • Creates the structure for a guild.

      Parameters

      • client: Client

        The client instance.

      • data:
            | GuildStorageJSON
            | GuildCacheJSON
            | GuildDiscordJSON
            | GatewayGuildCreateDispatchData
            | APIGuild

        Raw guild data.

      • options: { nocache?: false } = ...

        The additional options for this structure.

        • Optionalnocache?: false

          Whether this guild should be cached or not.

      Returns Guild

      https://discord.com/developers/docs/resources/guild#guild-object

    Accessors

    _cacheOptions

    • get _cacheOptions(): GuildCacheOptions

      The cache options for this guild.

      Returns GuildCacheOptions

    _originalIconHash

    • get _originalIconHash(): null | string

      The hash of the guild's icon, as it was received from Discord.

      Returns null | string

    • get auditLogs(): GuildAuditLogManager

      Returns GuildAuditLogManager

    • get channels(): GuildChannelsManager

      The channels in the guild.

      Returns GuildChannelsManager

    • get description(): null | string

      The description of the guild.

      Returns null | string

    • get displayIconURL(): null | string

      The icon URL of the guild.

      Returns null | string

    • get emojis(): GuildEmojisManager

      The emojis in the guild.

      Returns GuildEmojisManager

    • get invites(): GuildInviteManager

      The invites in the guild.

      Returns GuildInviteManager

    • get joinedAt(): undefined | number

      The id of the guild owner.

      Returns undefined | number

    • get memberCount(): number

      The member count of the guild.

      Returns number

    • get members(): GuildMemberManager

      The members in the guild.

      Returns GuildMemberManager

    • get ownerId(): string

      The icon hash of the guild.

      Returns string

    • get preferredLocale(): Locale

      The preferred locale of the guild.

      Returns Locale

    • get premiumProgressBarEnabled(): boolean

      Whether the guild has the boost progress bar enabled.

      Returns boolean

    • get premiumSubscriptionCount(): number

      The premium subscription count of the guild.

      Returns number

    • get roles(): GuildRoleManager

      The roles in the guild.

      Returns GuildRoleManager

    • get rulesChannel(): null | TextChannel

      The rules channel of the guild.

      Returns null | TextChannel

    • get rulesChannelId(): null | string

      The rules channel id of the guild.

      Returns null | string

    • get scheduledEvents(): GuildScheduledEventManager

      The scheduled events in the guild.

      Returns GuildScheduledEventManager

    • get systemChannel(): null | TextChannel

      The system channel of the guild.

      Returns null | TextChannel

    • get systemChannelId(): null | string

      The system channel id of the guild.

      Returns null | string

    • get unavailable(): boolean

      Whether the guild is unavailable.

      Returns boolean

    • get voiceStates(): GuildVoiceStatesManager

      The voice states in the guild.

      Returns GuildVoiceStatesManager

    Methods

    _decrementMemberCount

    • _decrementMemberCount(): void

      Decreases the member count of the guild.

      Returns void

    _incrementMemberCount

    • _incrementMemberCount(): void

      Increases the member count of the guild.

      Returns void

    _intervalCallback

    • Bans a user with the given id from the guild.

      Parameters

      • user_id: string

        The id of the user to ban.

      • Optionaloptions: { reason?: string; seconds?: number } = {}

        Ban options.

        • Optionalreason?: string

          The reason for banning the user.

        • Optionalseconds?: number

          The number of seconds to delete messages for.

      Returns Promise<void>

    • Calculates the number of members that should be cached for this guild.

      Returns number

    • Calculates the number of messages that should be cached per channel for this guild.

      Returns number

    • Fetches audit logs.

      Parameters

      • Optionaloptions: {
            after?: string;
            before?: string;
            limit?: number;
            type?: AuditLogEvent;
            user_id?: string;
        } = {}

        Audit log fetch options.

        • Optionalafter?: string

          The id of the audit log entry to fetch after

        • Optionalbefore?: string

          The id of the audit log entry to fetch before.

        • Optionallimit?: number

          The number of entries to fetch.

        • Optionaltype?: AuditLogEvent

          The type of audit log to fetch.

        • Optionaluser_id?: string

          The id of the user to fetch the audit log for.

      Returns Promise<AuditLog[]>

    • Fetches the ban for the provided user id.

      Parameters

      • user_id: string

        The id of the user to fetch the ban of.

      Returns Promise<any>

    • Fetches all the guild channels.

      Returns Promise<(TextChannel | VoiceChannel | Thread | CategoryChannel)[]>

    • Fetches the guild invites.

      Returns Promise<any>

    • Kicks a user with the given id from the guild.

      Parameters

      • user_id: string

        The id of the user to kick.

      • Optionaloptions: { reason?: string } = {}

        Kick options.

        • Optionalreason?: string

          The reason for kicking the user.

      Returns Promise<void>

    • Leaves the guild.

      Returns Promise<void>

    • Returns the client member for this guild.

      Returns Promise<Member>

    • Removes the given role from the given member.

      Parameters

      • user_id: string

        The id of the user.

      • role_id: string

        The id of the role.

      • Optionaloptions: { reason?: string } = {}

        Remove role options.

        • Optionalreason?: string

          The reason for removing the role.

      Returns Promise<void>

    • Returns the JSON representation of this structure.

      Parameters

      Returns GuildStorageJSON | GuildCacheJSON | GuildDiscordJSON

    • Unbans a user with the given id from the guild.

      Parameters

      • user_id: string

        The id of the user to unban.

      • Optionaloptions: { reason?: string } = {}

        Unban options.

        • Optionalreason?: string

          The reason for unbanning the user.

      Returns Promise<void>

    • Creates a webhook in the given channel with the name "Gluon".

      Parameters

      • client: Client

        The client instance.

      • channelId: string

        The id of the channel to create the webhook in.

      • Optionaloptions: { name?: string } = ...

        The options for creating the webhook.

        • Optionalname?: string

          The name of the webhook.

      Returns any

    • Deletes a webhook.

      Parameters

      • client: Client

        The client instance.

      • webhookId: string

        The id of the webhook to delete.

      Returns Promise<void>

    • Fetches a webhook by the webhook's id.

      Parameters

      • client: Client

        The client instance.

      • webhookId: string

        The id of the webhook to fetch.

      • Optionalguild: Guild

      Returns Promise<APIWebhook>

    • Returns the icon URL of the guild.

      Parameters

      • id: string

        The id of the guild.

      • Optionalhash: null | string

        The hash of the guild icon.

      Returns null | string

    • Modified a webhook with the given webhook id.

      Parameters

      • client: Client

        The client instance.

      • webhookId: string

        The id of the webhook to modify.

      • options: { channelId: string }

        The options to modify the webhook with.

        • channelId: string

          The id of the channel the webhook belongs to.

      Returns any

    • Posts a webhook with the provided webhook id and token.

      Parameters

      • client: Client

        The client instance.

      • referenceData: { id: string; token: string }

        An object with the webhook id and token.

        • id: string

          The id of the webhook.

        • token: string

          The token of the webhook.

      • Optionaloptions: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
        } = {}

        Embeds, components and files to attach to the webhook.

        • Optionalcomponents?: MessageComponents

          The components to attach to the webhook.

        • Optionalcontent?: string

          The content to attach to the webhook.

        • Optionalembeds?: Embed[]

          The embeds to attach to the webhook.

        • Optionalfiles?: FileUpload[]

          The files to attach to the webhook.

      Returns Promise<void>

    • Determines whether the emoji should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods