Class OAuthGuild

Represents a guild retrieved via oauth.

Hierarchy (view full)

Constructors

constructor

Properties

approximateMemberCount? approximatePresenceCount? client features icon id name owner permissions

Accessors

completeGuild createdAt

Methods

iconURL toJSON toString generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Optional approximateMemberCount

approximateMemberCount?: number

The approximate number of members in this guild (if retrieved with counts).

Optional approximatePresenceCount

approximatePresenceCount?: number

The approximate number of non-offline members in this guild (if retrieved with counts).

client

client: Client<ClientEvents>

features

features: ("ACTIVITIES_ALPHA" | "ACTIVITIES_EMPLOYEE" | "ACTIVITIES_INTERNAL_DEV" | "ANIMATED_BANNER" | "ANIMATED_ICON" | "APPLICATION_COMMAND_PERMISSIONS_V2" | "AUTO_MODERATION" | "AUTOMOD_TRIGGER_USER_PROFILE" | "BANNER" | "BOT_DEVELOPER_EARLY_ACCESS" | "BURST_REACTIONS" | "CHANNEL_HIGHLIGHTS_DISABLED" | "CHANNEL_HIGHLIGHTS" | "CHANNEL_ICON_EMOJIS_GENERATED" | "CLYDE_DISABLED" | "CLYDE_ENABLED" | "CLYDE_EXPERIMENT_ENABLED" | "COMMERCE" | "COMMUNITY_CANARY" | "COMMUNITY_EXP_LARGE_GATED" | "COMMUNITY_EXP_LARGE_UNGATED" | "COMMUNITY_EXP_MEDIUM" | "COMMUNITY" | "CREATOR_ACCEPTED_NEW_TERMS" | "CREATOR_MONETIZABLE_DISABLED" | "CREATOR_MONETIZABLE_PENDING_NEW_OWNER_ONBOARDING" | "CREATOR_MONETIZABLE_PROVISIONAL" | "CREATOR_MONETIZABLE_RESTRICTED" | "CREATOR_MONETIZABLE_WHITEGLOVE" | "CREATOR_MONETIZABLE" | "CREATOR_STORE_PAGE" | "DEVELOPER_SUPPORT_SERVER" | "DISCOVERABLE_DISABLED" | "DISCOVERABLE" | "ENABLED_DISCOVERABLE_BEFORE" | "ENABLED_MODERATION_EXPERIENCE_FOR_NON_COMMUNITY" | "EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT" | "FEATURABLE" | "GUESTS_ENABLED" | "GUILD_HOME_DEPRECATION_OVERRIDE" | "GUILD_HOME_OVERRIDE" | "GUILD_HOME_TEST" | "GUILD_ONBOARDING_EVER_ENABLED" | "GUILD_ONBOARDING_HAS_PROMPTS" | "GUILD_ONBOARDING" | "GUILD_ROLE_SUBSCRIPTION_TIER_TEMPLATE" | "GUILD_SERVER_GUIDE" | "GUILD_WEB_PAGE_VANITY_URL" | "HAD_EARLY_ACTIVITIES_ACCESS" | "HAS_DIRECTORY_ENTRY" | "HUB" | "INCREASED_THREAD_LIMIT" | "INTERNAL_EMPLOYEE_ONLY" | "INVITE_SPLASH" | "INVITES_DISABLED" | "LINKED_TO_HUB" | "MARKETPLACES_CONNECTION_ROLES" | "MEMBER_PROFILES" | "MEMBER_SAFETY_PAGE_ROLLOUT" | "MEMBER_VERIFICATION_GATE_ENABLED" | "MONETIZATION_ENABLED" | "MORE_EMOJI" | "MORE_EMOJIS" | "MORE_STICKERS" | "NEW_THREAD_PERMISSIONS" | "NEWS" | "NON_COMMUNITY_RAID_ALERTS" | "PARTNERED" | "PREVIEW_ENABLED" | "PREVIOUSLY_DISCOVERABLE" | "PRIVATE_THREADS" | "PRODUCTS_AVAILABLE_FOR_PURCHASE" | "RAID_ALERTS_DISABLED" | "RAID_ALERTS_ENABLED" | "ROLE_ICONS" | "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE" | "ROLE_SUBSCRIPTIONS_ENABLED" | "SEVEN_DAY_THREAD_ARCHIVE" | "SHARD" | "SOUNDBOARD" | "SUMMARIES_DISABLED_BY_USER" | "SUMMARIES_ENABLED_BY_USER" | "SUMMARIES_ENABLED_GA" | "SUMMARIES_ENABLED" | "SUMMARIES_OPT_OUT_EXPERIENCE" | "SUMMARIES_PAUSED" | "TEXT_IN_STAGE_ENABLED" | "TEXT_IN_VOICE_ENABLED" | "THREADS_ENABLED_TESTING" | "THREADS_ENABLED" | "THREE_DAY_THREAD_ARCHIVE" | "TICKETED_EVENTS_ENABLED" | "VANITY_URL" | "VERIFIED" | "VIP_REGIONS" | "VOICE_IN_THREADS" | "WELCOME_SCREEN_ENABLED")[]

The features this guild has.

icon

icon: null | string

The icon hash of this guild.

id

id: string

name

name: string

The name of this guild.

owner

owner: boolean

If the user is the owner of this guild.

permissions

permissions: Permission

The permissions of the user in this guild.

Accessors

completeGuild

createdAt

Methods

iconURL

  • iconURL(format?, size?): null | string

  • The url of this guild's icon.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns null | string

toJSON

toString

Static generateID

Static getCreatedAt

Static getDiscordEpoch

Settings

Member Visibility

Theme

On This Page

constructorapproximateMemberCountapproximatePresenceCountclientfeaturesiconidnameownerpermissionscompleteGuildcreatedAticonURLtoJSONtoStringgenerateIDgetCreatedAtgetDiscordEpoch