discord_guild_scheduled_event Struct Reference

#include <guild_scheduled_event.h>

Collaboration diagram for discord_guild_scheduled_event:

Data Fields
u64snowflake	id
u64snowflake	guild_id
u64snowflake	channel_id
u64snowflake	creator_id
char *	name
char *	description
u64unix_ms	scheduled_start_time
u64unix_ms	scheduled_end_time
enum discord_guild_scheduled_event_privacy_level	privacy_level
enum discord_guild_scheduled_event_status	status
enum discord_guild_scheduled_event_entity_types	entity_type
u64snowflake	entity_id
struct discord_guild_scheduled_event_entity_metadata *	entity_metadata
struct discord_user *	creator
int	user_count
char *	image

Detailed Description

Public methods

• Initializer:
  • discord_guild_scheduled_event_init(struct discord_guild_scheduled_event *this)
• Cleanup:
  • discord_guild_scheduled_event_cleanup(struct discord_guild_scheduled_event *this)
• JSON Decoder:
  • discord_guild_scheduled_event_from_json(const char json[], size_t len, struct discord_guild_scheduled_event *this)
  • discord_guild_scheduled_event_from_jsmnf(jsmnf *root, const char json[], struct discord_guild_scheduled_event *this)
• JSON Encoder:
  • discord_guild_scheduled_event_to_json(char buf[], size_t size, const struct discord_guild_scheduled_event *this)
  • discord_guild_scheduled_event_to_jsonb(jsonb *b, char buf[], size_t size, const struct discord_guild_scheduled_event *this)

Field Documentation

id

u64snowflake discord_guild_scheduled_event::id

the ID of the scheduled event

guild_id

u64snowflake discord_guild_scheduled_event::guild_id

the guild ID which the scheduled event belongs to

channel_id

u64snowflake discord_guild_scheduled_event::channel_id

the channel ID in which the scheduled event will be hosted, or NULL if entity_type is DISCORD_SCHEDULED_ENTITY_EXTERNAL

creator_id

u64snowflake discord_guild_scheduled_event::creator_id

the ID of the user that created the scheduled event

name

char* discord_guild_scheduled_event::name

the name of the scheduled event (1-100 characters)

description

char* discord_guild_scheduled_event::description

the description of the scheduled event (1-1000 characters)

scheduled_start_time

u64unix_ms discord_guild_scheduled_event::scheduled_start_time

the time the scheduled event will start

scheduled_end_time

u64unix_ms discord_guild_scheduled_event::scheduled_end_time

the time the scheduled event will end, required if entity_type is DISCORD_SCHEDULED_ENTITY_EXTERNAL

privacy_level

enum discord_guild_scheduled_event_privacy_level discord_guild_scheduled_event::privacy_level

the privacy level of the scheduled event

status

enum discord_guild_scheduled_event_status discord_guild_scheduled_event::status

the status of the scheduled event

entity_type

enum discord_guild_scheduled_event_entity_types discord_guild_scheduled_event::entity_type

the type of scheduled event

entity_id

u64snowflake discord_guild_scheduled_event::entity_id

the ID of an entity associated with a guild scheduled event

entity_metadata

struct discord_guild_scheduled_event_entity_metadata* discord_guild_scheduled_event::entity_metadata

additional metadata for the guild scheduled event

creator

struct discord_user* discord_guild_scheduled_event::creator

the user that created the scheduled event

user_count

int discord_guild_scheduled_event::user_count

the number of users subscribed to the scheduled event

image

char* discord_guild_scheduled_event::image

the cover image hashof the scheduled event

---

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

• docs/api/guild_scheduled_event.h