discord_channel Struct Reference

#include <channel.h>

Collaboration diagram for discord_channel:

Data Fields
u64snowflake	id
enum discord_channel_types	type
u64snowflake	guild_id
int	position
struct discord_overwrites *	permission_overwrites
char *	name
char *	topic
bool	nsfw
u64snowflake	last_message_id
int	bitrate
int	user_limit
int	rate_limit_per_user
struct discord_users *	recipients
char *	icon
u64snowflake	owner_id
u64snowflake	application_id
u64snowflake	parent_id
u64unix_ms	last_pin_timestamp
char *	rtc_region
int	voice_quality_mode
int	message_count
int	member_count
struct discord_thread_metadata *	thread_metadata
struct discord_thread_member *	member
int	default_auto_archive_duration
u64bitmask	permissions

Detailed Description

Public methods

• Initializer:
  • discord_channel_init(struct discord_channel *this)
• Cleanup:
  • discord_channel_cleanup(struct discord_channel *this)
• JSON Decoder:
  • discord_channel_from_json(const char json[], size_t len, struct discord_channel *this)
  • discord_channel_from_jsmnf(jsmnf *root, const char json[], struct discord_channel *this)
• JSON Encoder:
  • discord_channel_to_json(char buf[], size_t size, const struct discord_channel *this)
  • discord_channel_to_jsonb(jsonb *b, char buf[], size_t size, const struct discord_channel *this)

Examples

channel.c, and manual-dm.c.

Field Documentation

id

u64snowflake discord_channel::id

the ID of this channel

Examples

channel.c, fetch-messages.c, guild.c, and manual-dm.c.

type

enum discord_channel_types discord_channel::type

the type of channel

guild_id

u64snowflake discord_channel::guild_id

the ID of the guild (may be missing for some channel objects received over gateway guild dispatches)

position

int discord_channel::position

sorting position of the channel

permission_overwrites

struct discord_overwrites* discord_channel::permission_overwrites

explicit permission overwrites for members and roles

name

char* discord_channel::name

the name of the channel (0-1024 characters)

Examples

channel.c.

topic

char* discord_channel::topic

the channel topic (0-1024 characters)

nsfw

bool discord_channel::nsfw

whether the channel is nsfw

last_message_id

u64snowflake discord_channel::last_message_id

the id of the last message sent in this channel (may not point to an existing or valid message)

bitrate

int discord_channel::bitrate

the bitrate (in bits) of the voice channel

user_limit

int discord_channel::user_limit

the user limit of the voice channel

rate_limit_per_user

int discord_channel::rate_limit_per_user

amount of seconds a user has to wait before sending another message (0-21600). bots, as well as users with the permission MANAGE_MESSAGES or MANAGE_CHANNEL are unaffected

recipients

struct discord_users* discord_channel::recipients

array of user objects

icon

char* discord_channel::icon

icon hash of the group DM

owner_id

u64snowflake discord_channel::owner_id

id of the creator of the group DM or thread

application_id

u64snowflake discord_channel::application_id

application ID of the group DM creator if its bot-created

parent_id

u64snowflake discord_channel::parent_id

for guild channels: ID of the parent category for a channel (each parent category can contain up to 50 channels), for threads: id of the text channel this thread was created

last_pin_timestamp

u64unix_ms discord_channel::last_pin_timestamp

when the last pinned message was pinned. This may be NULL in events such as GUILD_CREATE when a message is not pinned

rtc_region

char* discord_channel::rtc_region

voice region ID for the voice channel, automatic when set to null

voice_quality_mode

int discord_channel::voice_quality_mode

the camera video quality mode of the voice channel, 1 when not present

message_count

int discord_channel::message_count

an approximate count of messages in a thread, stops counting at 50

member_count

int discord_channel::member_count

an approximate count of users in a thread, stops counting at 50

thread_metadata

struct discord_thread_metadata* discord_channel::thread_metadata

thread-specific fields not needed by other channels

member

struct discord_thread_member* discord_channel::member

thread member object for the current user, if they have joined the thread, only included on certain API endpoints

default_auto_archive_duration

int discord_channel::default_auto_archive_duration

default duration that the clients (not the API) will use for newly created threads, in minutes, to automatically archive the thread after recent activity, can be set to: 60, 1440, 4320, 10080

permissions

u64bitmask discord_channel::permissions

computed permissions for the invoking user in the channel, including overwrites, only included when part of the resolved data received on a application command interaction

---

The documentation for this struct was generated from the following file:

• docs/api/channel.h