Concepts

Concepts used in Discord BDK Book.

Guild

Represents a Discord guild (server) with its basic properties.This class encapsulates information about a Discord server including its ID, name, ownership status, permissions, features, and visual elements like icons and banners.

ALSO : server

Field Name	Description	Type
id	The unique identifier of the guild.	text
name	The name of the guild.	text
owner	Whether the current user is the owner of the guild.	boolean
permissions	The permissions the current user has in the guild.	text
features	List of guild features enabled for this guild.	list of text
icon	Hash of the guild's icon image.	optional[text]
banner	Hash of the guild's banner image.	optional[text]

Channel

Represents a Discord channel within a guild.This class encapsulates information about a Discord channel including its ID, type, name, guild association, position in the channel list, and parent channel if applicable.

ALSO : guild channel

Field Name	Description	Type
id	The unique identifier of the channel.	text
type	The type of the channel as an integer.	number
name	The name of the channel.	optional[text]
guild_id	The ID of the guild this channel belongs to.	optional[text]
position	The position of the channel in the guild's channel list.	optional[number]
parent_id	The ID of this channel's parent category.	optional[text]

Guild member

Represents a member of a Discord guild (server).This class encapsulates guild_member_json specific to a user's membership in a guild, such as their nickname, roles, join date, and the base User object.

ALSO : member

Field Name	Description	Type
user	The User object containing the member's base user information.	user
nick	The member's guild-specific nickname.	optional[text]
avatar	The member's guild-specific avatar hash.	optional[text]
roles	List of role IDs the member has in the guild.	list of text
joined_at	Timestamp when the user joined the guild.	datetime
premium_since	Timestamp when the user started boosting the guild.	optional[datetime]
deaf	Whether the member is deafened in voice channels.	boolean
mute	Whether the member is muted in voice channels.	boolean
flags	The member's guild flags.	number
pending	Whether the member has passed membership screening.	optional[boolean]
communication_disabled_until	Timestamp when timeout will be removed.	optional[datetime]
banner	The member's guild-specific banner hash.	optional[text]
unusual_dm_activity_until	Timestamp for unusual DM activity timeout.	optional[datetime]

User

Represents a Discord user with their profile information.This class encapsulates information about a Discord user including their ID, username, global name, discriminator, and various profile customization elements like avatars, banners, and decorations.

Field Name	Description	Type
id	The unique identifier of the user.	text
username	The user's username on Discord.	text
global_name	The user's global display name.	optional[text]
discriminator	The user's discriminator number.	text
accent_color	The user's profile accent color.	optional[number]
avatar	Hash of the user's avatar image.	optional[text]
avatar_decoration_data	Data for the user's avatar decorations.	optional[any?]
banner	Hash of the user's profile banner image.	optional[text]
banner_color	The user's banner color.	optional[text]
clan	Information about the user's clan.	optional[any?]
collectibles	The user's collectible items.	optional[any?]
flags	The user's account flags.	optional[number]
primary_guild	The ID of the user's primary guild.	optional[text]
public_flags	The user's public account flags.	optional[number]

Message body

Represents the content of a message to be sent to Discord.This class provides a simplified structure for constructing message payloads, supporting both plain text content and rich embeds.

Field Name	Description	Type
content	The text content of the message to be sent.	optional[text]
embeds	List of embedded rich content to be included in the message.	optional[list of json]

Embeds

No description

Message

Represents a Discord message with its core properties.This class encapsulates information about a Discord message including its ID, content text, and any rich embeds that may be part of the message.

Field Name	Description	Type
id	The unique identifier of the message.	text
content	The text content of the message.	optional[text]
embeds	List of embedded rich content in the message.	optional[list of json]