distype - v3.0.1
    Preparing search index...

    Interface CachedGuild

    A cached guild.

    interface CachedGuild {
        afk_channel_id?: null | string;
        afk_timeout?: 60 | 1800 | 3600 | 300 | 900;
        application_id?: null | string;
        approximate_member_count?: number;
        approximate_presence_count?: number;
        banner?: null | string;
        channels?: string[];
        default_message_notifications?: GuildDefaultMessageNotifications;
        description?: null | string;
        discovery_splash?: null | string;
        emojis?: APIEmoji[];
        explicit_content_filter?: GuildExplicitContentFilter;
        features?: GuildFeature[];
        guild_scheduled_events?: APIGuildScheduledEvent[];
        hub_type?: null | GuildHubType;
        icon?: null | string;
        icon_hash?: null | string;
        id: string;
        incidents_data?: null | APIIncidentsData;
        joined_at?: string;
        large?: boolean;
        max_members?: number;
        max_presences?: null | number;
        max_stage_video_channel_users?: number;
        max_video_channel_users?: number;
        member_count?: number;
        members?: string[];
        mfa_level?: GuildMFALevel;
        name?: string;
        nsfw_level?: GuildNSFWLevel;
        owner?: boolean;
        owner_id?: string;
        permissions?: string;
        preferred_locale?: Locale;
        premium_progress_bar_enabled?: boolean;
        premium_subscription_count?: number;
        premium_tier?: GuildPremiumTier;
        public_updates_channel_id?: null | string;
        region?: string;
        roles?: string[];
        rules_channel_id?: null | string;
        safety_alerts_channel_id?: null | string;
        soundboard_sounds?: APISoundboardSound[];
        splash?: null | string;
        stage_instances?: APIStageInstance[];
        stickers?: APISticker[];
        system_channel_flags?: GuildSystemChannelFlags;
        system_channel_id?: null | string;
        unavailable?: boolean;
        vanity_url_code?: null | string;
        verification_level?: GuildVerificationLevel;
        welcome_screen?: APIGuildWelcomeScreen;
        widget_channel_id?: null | string;
        widget_enabled?: boolean;
    }

    Hierarchy

    • Partial<
          Omit<
              DiscordTypes.GatewayGuildCreateDispatchData,
              | "channels"
              | "members"
              | "presences"
              | "roles"
              | "threads"
              | "voice_states",
          >,
      >
      • CachedGuild
    Index

    Properties

    afk_channel_id?: null | string

    ID of afk channel

    afk_timeout?: 60 | 1800 | 3600 | 300 | 900

    afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600

    application_id?: null | string

    Application id of the guild creator if it is bot-created

    approximate_member_count?: number

    Approximate number of members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true

    approximate_presence_count?: number

    Approximate number of non-offline members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true

    banner?: null | string

    Banner hash

    channels?: string[]

    The guild's channels, represented by their IDs. Note that threads are also included.

    default_message_notifications?: GuildDefaultMessageNotifications

    Default message notifications level

    description?: null | string

    The description for the guild

    discovery_splash?: null | string

    Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature

    emojis?: APIEmoji[]

    Custom guild emojis

    explicit_content_filter?: GuildExplicitContentFilter

    Explicit content filter level

    features?: GuildFeature[]

    Enabled guild features

    guild_scheduled_events?: APIGuildScheduledEvent[]

    The scheduled events in the guild

    This field is only sent within the GUILD_CREATE event

    hub_type?: null | GuildHubType

    The type of Student Hub the guild is

    icon?: null | string

    Icon hash

    icon_hash?: null | string

    Icon hash, returned when in the template object

    id: string

    The guild's ID. Always included, regardless of cache control.

    incidents_data?: null | APIIncidentsData

    The incidents data for this guild

    joined_at?: string

    When this guild was joined at

    This field is only sent within the GUILD_CREATE event

    large?: boolean

    true if this is considered a large guild

    This field is only sent within the GUILD_CREATE event

    max_members?: number

    The maximum number of members for the guild

    max_presences?: null | number

    The maximum number of presences for the guild (null is always returned, apart from the largest of guilds)

    max_stage_video_channel_users?: number

    The maximum amount of users in a stage video channel

    max_video_channel_users?: number

    The maximum amount of users in a video channel

    member_count?: number

    Total number of members in this guild

    This field is only sent within the GUILD_CREATE event

    members?: string[]

    The guild's members, represented by their IDs. Note that this field will not update if you do not have the GUILD_MEMBERS intent enabled.

    mfa_level?: GuildMFALevel

    Required MFA level for the guild

    name?: string

    Guild name (2-100 characters, excluding trailing and leading whitespace)

    nsfw_level?: GuildNSFWLevel

    The nsfw level of the guild

    owner?: boolean

    true if the user is the owner of the guild

    This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds

    owner_id?: string

    ID of owner

    permissions?: string

    Total permissions for the user in the guild (excludes overrides)

    This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds

    preferred_locale?: Locale

    The preferred locale of a Community guild; used in guild discovery and notices from Discord

    "en-US"

    premium_progress_bar_enabled?: boolean

    Whether the guild has the boost progress bar enabled.

    premium_subscription_count?: number

    The number of boosts this guild currently has

    premium_tier?: GuildPremiumTier

    Premium tier (Server Boost level)

    public_updates_channel_id?: null | string

    The id of the channel where admins and moderators of Community guilds receive notices from Discord

    region?: string

    Voice region id for the guild

    This field has been deprecated in favor of rtc_region on the channel.

    roles?: string[]

    The guild's roles, represented by their IDs.

    rules_channel_id?: null | string

    The id of the channel where Community guilds can display rules and/or guidelines

    safety_alerts_channel_id?: null | string

    The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord

    soundboard_sounds?: APISoundboardSound[]

    The soundboard sounds in the guild

    This field is only sent within the GUILD_CREATE event

    splash?: null | string

    Splash hash

    stage_instances?: APIStageInstance[]

    The stage instances in the guild

    This field is only sent within the GUILD_CREATE event

    stickers?: APISticker[]

    Custom guild stickers

    system_channel_flags?: GuildSystemChannelFlags

    System channel flags

    system_channel_id?: null | string

    The id of the channel where guild notices such as welcome messages and boost events are posted

    unavailable?: boolean

    true if this guild is unavailable due to an outage

    vanity_url_code?: null | string

    The vanity url code for the guild

    verification_level?: GuildVerificationLevel

    Verification level required for the guild

    welcome_screen?: APIGuildWelcomeScreen

    The welcome screen of a Community guild, shown to new members

    Returned in the invite object

    widget_channel_id?: null | string

    The channel id that the widget will generate an invite to, or null if set to no invite

    widget_enabled?: boolean

    true if the guild widget is enabled