discord_modify_guild_member Struct Reference

#include <guild.h>

Collaboration diagram for discord_modify_guild_member:

Data Fields
char *	reason
char *	nick
struct snowflakes *	roles
bool	mute
bool	deaf
u64snowflake	channel_id
u64unix_ms	communication_disabled_until

Detailed Description

Public methods

• Initializer:
  • discord_modify_guild_member_init(struct discord_modify_guild_member *this)
• Cleanup:
  • discord_modify_guild_member_cleanup(struct discord_modify_guild_member *this)
• JSON Decoder:
  • discord_modify_guild_member_from_json(const char json[], size_t len, struct discord_modify_guild_member *this)
  • discord_modify_guild_member_from_jsmnf(jsmnf *root, const char json[], struct discord_modify_guild_member *this)
• JSON Encoder:
  • discord_modify_guild_member_to_json(char buf[], size_t size, const struct discord_modify_guild_member *this)
  • discord_modify_guild_member_to_jsonb(jsonb *b, char buf[], size_t size, const struct discord_modify_guild_member *this)

Field Documentation

reason

char* discord_modify_guild_member::reason

Parameters

reason

a reason to indicate why the action was taken

nick

char* discord_modify_guild_member::nick

value to set user's nickname to

roles

struct snowflakes* discord_modify_guild_member::roles

array of role IDs the member is assigned

mute

bool discord_modify_guild_member::mute

whether the user is muted in voice channels. will return a CCORD_HTTP_ERROR (400) if the user is not in a voice channel

deaf

bool discord_modify_guild_member::deaf

whether the user is deafened in voice channels. will return a CCORD_HTTP_ERROR (400) if the user is not in a voice channel

channel_id

u64snowflake discord_modify_guild_member::channel_id

ID of channel to move user to (if they are connect to voice)

communication_disabled_until

u64unix_ms discord_modify_guild_member::communication_disabled_until

Todo:

should be able to write null

when the user's timeout will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to NULL to remove timeout. Will throw a CCORD_HTTP_ERROR (403) error if the user has the ADMINISTRATOR permission or is the owner of the guild

---

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

• docs/api/guild.h