GuildBuilder

Creates a guild.

Note :

  • When using the roles parameter, the first member of the array is used to change properties of the guild's @everyone role. If you are trying to bootstrap a guild with additional roles, keep this in mind.

  • When using the roles parameter, the required id field within each role object is an integer placeholder, and will be replaced by the API upon consumption. Its purpose is to allow you to overwrite a role's permissions in a channel when also passing in channels with the channels array.

  • When using the channels parameter, the position field is ignored, and none of the default channels are created.

  • When using the channels parameter, the id field within each channel object may be set to an integer placeholder, and will be replaced by the API upon consumption. Its purpose is to allow you to create GUILD_CATEGORY channels by setting the parent_id field on any children to the category's id field. Category channels must be listed before any children.

Inheritors

Functions

Link copied to clipboard
abstract fun create(): CompletableDeferred<Guild>

Creates the new entity.

Link copied to clipboard
abstract fun setAfkChannelId(afkChannelId: String): GuildBuilder

Sets the afk channel id of the guild.

Link copied to clipboard
abstract fun setAfkTimeout(afkTimeout: Int): GuildBuilder

Sets the afk timeout of the guild.

Link copied to clipboard
abstract fun setDefaultMessageNotifications(defaultMessageNotifications: MessageNotificationLevel): GuildBuilder

Sets the default message notification level of the guild.

Link copied to clipboard

Sets the explicit content filter level of the guild.

Link copied to clipboard
abstract fun setIcon(icon: String): GuildBuilder

Sets the icon of the guild.

Link copied to clipboard

Sets the message channels of the guild.

Link copied to clipboard
abstract fun setRoles(roles: List<RoleBuilder>): GuildBuilder

Sets the roles of the guild.

Link copied to clipboard
abstract fun setSystemChannelFlags(systemChannelFlags: SystemChannelFlag): GuildBuilder

Sets the system channel flags of the guild.

Link copied to clipboard
abstract fun setSystemChannelId(systemChannelId: String): GuildBuilder

Sets the system channel id of the guild.

Link copied to clipboard
abstract fun setVerificationLevel(verificationLevel: VerificationLevel): GuildBuilder

Sets the verification level of the guild.

Link copied to clipboard

Sets the voice channels of the guild.

Properties

Link copied to clipboard
abstract val json: JsonNode

The json that will be sent to the discord api.