Class

Guild

Represents a Fluxer guild (server).

Extends Base

Constructor1 Properties27 Methods42 Source

Constructor

new Guild(client: Client, data: GuildData)

Construct a guild from API data.

Param	Type	Description
client	`Client`
data	`GuildData`	API guild from GET /guilds/{id} or gateway GUILD_CREATE

Properties

afkChannelId: string | null

AFK voice channel ID, or null if none.

afkTimeout: number

AFK timeout in seconds.

bannerHeight?: number | null

Banner height in pixels.

bannerWidth?: number | null

Banner width in pixels.

channels: Collection<string, GuildChannel>

Cached channels in this guild.

client: Client (readonly)

The Client that instantiated this guild.

defaultMessageNotifications: DefaultMessageNotifications

Default notification level for members.

emojis: Collection<string, GuildEmoji>

Cached emojis in this guild.

explicitContentFilter: GuildExplicitContentFilter

Explicit content filter level.

features: GuildFeature[]

Features enabled for this guild.

icon: string | null

Icon hash (use iconURL to get full CDN URL).

id: string (readonly)

Snowflake ID of this guild.

members: GuildMemberManager

Member manager for this guild (fetch/add/remove members).

mfaLevel: GuildMFALevel

MFA level required for moderation actions.

name: string

Guild name.

nsfwLevel: GuildNSFWLevel

NSFW level for this guild.

ownerId: string

User ID of the guild owner.

roles: Collection<string, Role>

Cached roles in this guild.

rulesChannelId: string | null

Rules channel ID (for Community guilds), or null if none.

splash: string | null

Invite splash hash (use splashURL to get full CDN URL).

splashHeight?: number | null

Splash height in pixels.

splashWidth?: number | null

Splash width in pixels.

stickers: Collection<string, GuildSticker>

Cached stickers in this guild.

systemChannelId: string | null

System messages channel ID, or null if none.

vanityURLCode: string | null

Vanity invite code if the guild has one.

verificationLevel: GuildVerificationLevel

Verification level required for members to send messages.

Methods

applyForDiscovery(body: DiscoveryApplicationOptions): Promise<DiscoveryApplicationPayload>

Apply for guild discovery.

Param	Type	Description
body	`DiscoveryApplicationOptions`

ban(userId: string, options?: GuildBanOptions): Promise<void>

Ban a user from the guild. Requires Ban Members. `ban_duration_seconds`: 0 = permanent.

Param	Type	Description
userId	`string`
options?	`GuildBanOptions`

bannerURL(options?: { size?: number; }): string | null

Get the full CDN URL for the guild's banner (or null).

Param	Type	Description
options?	`{ size?: number; }`

cloneEmoji(sourceEmojiId: string): Promise<GuildEmoji>

Clone an emoji from another guild. Requires Manage Emojis and Stickers.

Param	Type	Description
sourceEmojiId	`string`

cloneSticker(sourceStickerId: string): Promise<GuildSticker>

Clone a sticker from another guild. Requires Manage Emojis and Stickers.

Param	Type	Description
sourceStickerId	`string`

createChannel(data: ChannelCreateRequest): Promise<GuildChannel>

Create a channel. `data.type`: 0=text, 2=voice, 4=category, 998=link (set `url`). Requires Manage Channels.

Param	Type	Description
data	`ChannelCreateRequest`

createEmoji(options: { name: string; image: string; }): Promise<GuildEmoji>

Create a new emoji in this guild. Requires Manage Emojis and Stickers.

Param	Type	Description
options	`{ name: string; image: string; }`

createEmojisBulk

(emojiList: Array<{ name: string; image: string }>): Promise<{ success: GuildEmoji[]; failed: Array<{ name: string; error: string }> }>

Create multiple emojis at once (bulk operation).

Param	Type	Description
emojiList	`Array<{ name: string; image: string }>`

createRole(options: RoleCreateOptions): Promise<Role>

Create a role. `permissions` accepts a bitfield string or PermissionResolvable.

Param	Type	Description
options	`RoleCreateOptions`

createSticker(options: { name: string; image: string; description?: string | null; tags?: string[]; }): Promise<GuildSticker>

Create a new sticker in this guild. Requires Manage Emojis and Stickers.

Param	Type	Description
options	`{ name: string; image: string; description?: string \| null; tags?: string[]; }`

createStickersBulk

(stickerList: Array<{ name: string; image: string; description?: string; tags?: string[] }>): Promise<{ success: GuildSticker[]; failed: Array<{ name: string; error: string }> }>

Create multiple stickers at once (bulk operation).

Param	Type	Description
stickerList	`Array<{ name: string; image: string; description?: string; tags?: string[] }>`

delete(options?: SudoVerificationOptions): Promise<void>

Delete this guild (owner only). User accounts may need sudo/MFA in `options`.

Param	Type	Description
options?	`SudoVerificationOptions`

edit(options: GuildEditOptions): Promise<this>

Edit guild settings. Requires guild owner or Administrator.

Param	Type	Description
options	`GuildEditOptions`

editDiscoveryApplication(body: DiscoveryApplicationOptions): Promise<DiscoveryApplicationPayload>

Edit an existing discovery application.

Param	Type	Description
body	`DiscoveryApplicationOptions`

editVanityURL(code: string | null): Promise<VanityURLPayload>

Edit the guild's vanity invite code.

Param	Type	Description
code	`string \| null`

fetchAuditLogs

(options?: { limit?: number; before?: string; after?: string; userId?: string; actionType?: AuditLogActionType; }): Promise<AuditLogFetchPayload>

Fetch audit log entries. Requires View Audit Log.

Param	Type	Description
options?	`{ limit?: number; before?: string; after?: string; userId?: string; actionType?: AuditLogActionType; }`

fetchBans(): Promise<GuildBan[]>

Fetch all bans in this guild. Requires Ban Members.

fetchChannels(): Promise<GuildChannel[]>

Fetch all channels in this guild from the API.

fetchDiscoveryStatus(): Promise<DiscoveryStatusPayload>

Fetch the guild's discovery status.

fetchEmoji(emojiId: string): Promise<GuildEmoji>

Fetch a specific emoji by ID.

Param	Type	Description
emojiId	`string`

fetchEmojis(): Promise<GuildEmoji[]>

Fetch all emojis in this guild from the API.

fetchInvite(codeOrUrl: string): Promise<Invite>

Fetch a specific invite by code or URL.

Param	Type	Description
codeOrUrl	`string`

fetchInvites(): Promise<Invite[]>

Fetch all invites in this guild. Requires Manage Guild.

fetchMe(): Promise<GuildMember>

Fetch the bot's own member object in this guild.

fetchMember(userId: string): Promise<GuildMember>

Fetch a guild member by user ID.

Param	Type	Description
userId	`string`

fetchRole(roleId: string): Promise<Role>

Fetch a specific role by ID.

Param	Type	Description
roleId	`string`

fetchRoles(): Promise<Role[]>

Fetch all roles in this guild from the API.

fetchSticker(stickerId: string): Promise<GuildSticker>

Fetch a specific sticker by ID.

Param	Type	Description
stickerId	`string`

fetchStickers(): Promise<GuildSticker[]>

Fetch all stickers in this guild from the API.

fetchVanityURL(): Promise<VanityURLPayload>

Fetch the guild's vanity invite URL (if available).

fetchWebhooks(): Promise<Webhook[]>

Fetch all webhooks in this guild.

iconURL(options?: { size?: number; }): string | null

Get the full CDN URL for the guild's icon (or null).

Param	Type	Description
options?	`{ size?: number; }`

kick(userId: string): Promise<void>

Kick a user from the guild. Requires Kick Members.

Param	Type	Description
userId	`string`

resetRoleHoistPositions(): Promise<Role[]>

Reset all role hoist positions to zero. Returns cached Role instances.

resolveRoleId(arg: string): Promise<string | null>

Resolve role mention, snowflake, or name to a role ID.

Param	Type	Description
arg	`string`

setChannelPositions(updates: ChannelPositionUpdate[]): Promise<void>

Update channel positions (reordering).

Param	Type	Description
updates	`ChannelPositionUpdate[]`

setRoleHoistPositions(updates: Array<{ id: string; hoistPosition?: number }>): Promise<Role[]>

Update role hoist positions (visual separator groups). Returns cached Role instances.

Param	Type	Description
updates	`Array<{ id: string; hoistPosition?: number }>`

setRolePositions(updates: Array<{ id: string; position?: number }>): Promise<Role[]>

Update role positions (reordering). Returns cached Role instances.

Param	Type	Description
updates	`Array<{ id: string; position?: number }>`

splashURL(options?: { size?: number; }): string | null

Get the full CDN URL for the guild's invite splash (or null).

Param	Type	Description
options?	`{ size?: number; }`

transferOwnership(newOwnerId: string, password?: string): Promise<void>

Transfer guild ownership to another user (owner only).

Param	Type	Description
newOwnerId	`string`
password?	`string`

unban(userId: string): Promise<void>

Unban a user from the guild. Requires Ban Members.

Param	Type	Description
userId	`string`

withdrawDiscoveryApplication(): Promise<void>

Withdraw the guild's discovery application.