detritus
On this page

Guild Structure

import { Structures } from 'detritus-client';

Structures.Guild;
83 properties10 methods120 inheritedsrc/structures/guild.ts:797

Constructor

Properties

_channelIds
BaseSet<string>
readonly
_hasPresences
boolean
Default false
_threadIds
BaseSet<string>
readonly
afkChannelId
string | null
Default null
afkTimeout
number
Default 0
applicationId?
string | null
optional
approximateMemberCount?
number
optional
approximatePresenceCount?
number
optional
autoModerationRules
client
readonly
Inherited from GuildPartial.client
defaultMessageNotifications
number
Default 0
description
string | null
Default null
discoverySplash
string | null
Default null
emojis
explicitContentFilter
Default GuildExplicitContentFilterTypes.DISABLED
features
BaseSet<string>
guildScheduledEvents
hasMetadata
boolean
Default false
icon
string | null
Default null
id
string
Default ''
Overrides GuildPartial.id
incidentsData
Default null
isPartial
boolean
Default false
isReady
boolean
Default false
joinedAtUnix
number
Default 0
large
boolean
Default false
lazy
boolean
Default false
left
boolean
Default false
maxMembers
number
Default DEFAULT_MAX_MEMBERS
maxPresences
number
Default DEFAULT_MAX_PRESENCES
maxStageVideoChannelUsers?
number
optional
maxVideoChannelUsers
number
Default DEFAULT_MAX_VIDEO_CHANNEL_USERS
memberCount
number
Default 0
members
mfaLevel
Default MfaLevels.NONE
name
string
Default ''
nsfw
boolean
Default false
nsfwLevel
Default GuildNSFWLevels.DEFAULT
ownerId
string
Default ''
preferredLocale
Default Locales.ENGLISH_US
premiumProgressBarEnabled
boolean
Default false
premiumSubscriptionCount
number
Default 0
premiumTier
Default PremiumGuildTiers.NONE
publicUpdatesChannelId
string | null
Default null
region
string
Default ''
roles
rulesChannelId
string | null
Default null
safetyAlertsChannelId
string | null
Default null
soundboardSounds
splash
string | null
Default null
stageInstances
stickers
systemChannelFlags
number
Default 0
systemChannelId
string | null
Default null
unavailable
boolean
Default false
vanityUrlCode
string | null
Default null
verificationLevel
number
Default 0
welcomeScreen
Default null
widgetChannelId
string | null
Default null
widgetEnabled
boolean
Default false

Accessors

acronym
string
get
Inherited from GuildPartial.acronym
afkChannel
Channel | null
get
allTextChannels
allVoiceChannels
bannerUrl
string | null
get
Inherited from GuildPartial.bannerUrl
canHaveBanner
boolean
get
canHaveDiscoveryFeatures
boolean
get
canHaveNews
boolean
get
canHavePublic
boolean
get
canHaveSplash
boolean
get
canHaveStore
boolean
get
canHaveTextInVoice
boolean
get
canHaveVanityUrl
boolean
get
canHaveVipRegions
boolean
get
categoryChannels
channels
get
createdAt
Date
get
Inherited from GuildPartial.createdAt
createdAtUnix
number
get
defaultRole
Role | null
get
discoverySplashUrl
string | null
get
hasSystemChannelSuppressJoinNotifications
boolean
get
hasSystemChannelSuppressPremiumSubscriptions
boolean
get
iconUrl
string | null
get
Inherited from GuildPartial.iconUrl
isClone
boolean
get
Inherited from GuildPartial.isClone
isDiscoverable
boolean
get
isPartnered
boolean
get
isPublic
boolean
get
Inherited from GuildPartial.isPublic
isVerified
boolean
get
joinedAt
Date | null
get
maxAttachmentSize
number
get
maxBitrate
number
get
maxEmojis
number
get
me
Member | null
get
messages
get
owner
User | null
get
preferredLocaleText
string
get
presences
get
publicUpdatesChannel
Channel | null
get
rulesChannel
Channel | null
get
shardId
number
get
Inherited from GuildPartial.shardId
splashUrl
string | null
get
Inherited from GuildPartial.splashUrl
stageVoiceChannels
storeChannels
systemChannel
Channel | null
get
textChannels
threads
voiceChannels
voiceStates
get
widgetImageUrl
string
get
widgetUrl
string
get
Inherited from GuildPartial.widgetUrl

Methods

clone()

src/structures/guild.ts:1248
clone(): this

Copies everything except the channels, members, presences, threads and voice states serializing those took hundreds of milliseconds on big guilds, for every GUILD_UPDATE with a listener the copy keeps the channel/thread ids (its channels/threads read the client's cache like any guild) and shares the live members collection

permissionsFor()

src/structures/guild.ts:1178
permissionsFor(
  member: Member,
  channel?: string | Channel,
  options?: { ignoreAdministrator?: boolean; ignoreOwner?: boolean },
): bigint
member
channel?
string | Channel
options?
{ ignoreAdministrator?: boolean; ignoreOwner?: boolean }
options.ignoreAdministrator?
boolean
options.ignoreOwner?
boolean

requestMembers()

async src/structures/guild.ts:524
requestMembers(
  options: { limit?: number; presences?: boolean; query: string; timeout?: number; userIds?: string[] },
): Promise<{ members: BaseCollection<string, Member>; nonce: string; notFound: BaseSet<string>; presences: BaseCollection<string, Presence> }>
options
{ limit?: number; presences?: boolean; query: string; timeout?: number; userIds?: string[] }
options.limit?
number
options.presences?
boolean
options.query
string
options.timeout?
number
options.userIds?
string[]