Results

Namespace

Type

Options for discord.Guild.edit, requires [[discord.Permission.MANAGE_GUILD]] to modify options.

Hierarchy

  • IGuildOptions <-- You are here!

Index

Properties

Optional afkChannelId

afkChannelId: Snowflake | null

Sets the id of a discord.GuildVoiceChannel to send users to after being idle for longer than discord.Guild.afkTimeout.

If null, the AFK timeout is disabled.

Optional afkTimeout

afkTimeout: undefined | number

Sets the amount of time (in seconds) until users idle in voice channels are moved to the AFK channel, if set.

Note: To enable/disable AFK channel timeouts, set afkChannelId to a valid discord.GuildVoiceChannel's id.

Optional banner

banner: ArrayBuffer | string | null

Sets a new guild invite page background. Requires the discord.Guild.Feature.BANNER feature on the guild.

Accepts image data in the format of JPEG only.

If a string is passed, please pass a base64 encoded data URI.

If null, the banner is removed.

Optional defaultMessageNotifications

defaultMessageNotifications: NotificationsLevel

Sets what new members' default notification settings should be.

See discord.Guild.NotificationsLevel for a list of possible options.

Optional explicitContentFilter

explicitContentFilter: ExplicitContentFilterLevel

Sets the level of content scanning Discord should perform on images sent by members.

See discord.Guild.ExplicitContentFilterLevel for a list of possible options.

Optional icon

icon: ArrayBuffer | string | null

Sets a new guild icon. Accepts image data in the format of JPEG, PNG, or GIF.

If a string is passed, please pass a base64 encoded data URI.

If null, the icon is removed.

Optional name

name: undefined | string

Sets the name of the guild.

Optional ownerId

ownerId: Snowflake

The id of a user to transfer this guild to. Typically, bots will not be the owner of a guild.

Optional region

region: Region

Sets the voice region this guild should use for voice channels.

See discord.Guild.Region for a list of possible options.

Optional splash

splash: ArrayBuffer | string | null

Sets a new guild invite page background/splash image. Requires the discord.Guild.Feature.INVITE_SPLASH feature on the guild.

Accepts image data in the format of JPEG only.

If a string is passed, please pass a base64 encoded data URI.

If null, the invite background splash image is removed.

Optional systemChannelId

systemChannelId: Snowflake | null

Sets the id of the discord.GuildTextChannel to send welcome messages and server boost messages to.

If null, the feature is disabled.

Optional verificationLevel

verificationLevel: VerificationLevel

Sets the verification level for this guild. Applies to members without any roles.

See discord.Guild.VerificationLevel for a list of possible options.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc