discord_modify_channel Struct Reference

#include <channel.h>

Collaboration diagram for discord_modify_channel:

Data Fields
char *	reason
char *	name
enum discord_channel_types	type
int	position
char *	topic
bool	nsfw
int	rate_limit_per_user
int	user_limit
struct discord_overwrites *	permission_overwrites
u64snowflake	parent_id
char *	rtc_region
int	video_quality_mode
int	default_auto_archive_duration
bool	archived
int	auto_archive_duration
bool	locked
bool	invitable

Detailed Description

Public methods

• Initializer:
  • discord_modify_channel_init(struct discord_modify_channel *this)
• Cleanup:
  • discord_modify_channel_cleanup(struct discord_modify_channel *this)
• JSON Decoder:
  • discord_modify_channel_from_json(const char json[], size_t len, struct discord_modify_channel *this)
  • discord_modify_channel_from_jsmnf(jsmnf *root, const char json[], struct discord_modify_channel *this)
• JSON Encoder:
  • discord_modify_channel_to_json(char buf[], size_t size, const struct discord_modify_channel *this)
  • discord_modify_channel_to_jsonb(jsonb *b, char buf[], size_t size, const struct discord_modify_channel *this)

Examples

channel.c.

Field Documentation

reason

char* discord_modify_channel::reason

Parameters

reason

a reason to indicate why the action was taken

name

char* discord_modify_channel::name

1-100 character channel name

Examples

channel.c.

type

enum discord_channel_types discord_modify_channel::type

the type of channel; only conversion between text and news is supported and only in guilds with the NEWS feature

position

int discord_modify_channel::position

the position of the channel in the left-hand listing

topic

char* discord_modify_channel::topic

0-1024 character channel topic

nsfw

bool discord_modify_channel::nsfw

whether the channel is nsfw

rate_limit_per_user

int discord_modify_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

user_limit

int discord_modify_channel::user_limit

the user limit of the voice channel; 0 refers to no limit, 1 to 99 refers to a user limit

permission_overwrites

struct discord_overwrites* discord_modify_channel::permission_overwrites

channel or category-specific permissions

parent_id

u64snowflake discord_modify_channel::parent_id

ID of the new parent category for a channel

rtc_region

char* discord_modify_channel::rtc_region

channel voice region id, automatic when set to NULL

video_quality_mode

int discord_modify_channel::video_quality_mode

the camera video quality mode of the voice channel

default_auto_archive_duration

int discord_modify_channel::default_auto_archive_duration

the default duration that the clients use (not the API) for newly created threads in the channel, in minutes, to automatically archive the thread after recent activity

archived

bool discord_modify_channel::archived

whether the thread is archived

auto_archive_duration

int discord_modify_channel::auto_archive_duration

duration in minutes to automatically arhived the thread after recent activity, can be set to: 60, 1440, 4320, 10080

locked

bool discord_modify_channel::locked

whether the thread is locked; when a thread is locked, only users with MANAGE_THREADS can unarchive it

invitable

bool discord_modify_channel::invitable

whether non-moderators can add other non-moderators to a thread; only available on private threads

---

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

• docs/api/channel.h