dpp::scheduled_event Struct Reference

A scheduled event. More...

#include <scheduled_event.h>

Collaboration diagram for dpp::scheduled_event:

Public Member Functions
	scheduled_event ()
	Create a scheduled_event object. More...
	~scheduled_event ()=default
	Destroy the scheduled_event object. More...
scheduled_event &	set_name (const std::string &n)
	Set the name of the event Minimum length: 1, Maximum length: 100. More...
scheduled_event &	set_description (const std::string &d)
	Set the description of the event Minimum length: 1 (if set), Maximum length: 100. More...
scheduled_event &	clear_description ()
	Clear the description of the event. More...
scheduled_event &	set_location (const std::string &l)
	Set the location of the event. Minimum length: 1, Maximum length: 1000. More...
scheduled_event &	set_channel_id (snowflake c)
	Set the voice channel id of the event. More...
scheduled_event &	set_creator_id (snowflake c)
	Set the creator id of the event. More...
scheduled_event &	set_status (event_status s)
	Set the status of the event. More...
scheduled_event &	set_start_time (time_t t)
	Set the start time of the event. More...
scheduled_event &	set_end_time (time_t t)
	Set the end time of the event. More...
scheduled_event &	fill_from_json (const nlohmann::json *j)
	Serialise a scheduled_event object from json. More...
std::string const	build_json (bool with_id=false) const
	Build json for this object. More...

Public Attributes
snowflake	id
	the id of the scheduled event More...
snowflake	guild_id
	the guild id which the scheduled event belongs to More...
snowflake	channel_id
	the channel id in which the scheduled event will be hosted, or null if scheduled entity type is EXTERNAL (may be empty) More...
snowflake	creator_id
	Optional: the id of the user that created the scheduled event. More...
std::string	name
	the name of the scheduled event More...
std::string	description
	Optional: the description of the scheduled event. More...
std::string	image
	the image of the scheduled event (may be empty) More...
time_t	scheduled_start_time
	the time the scheduled event will start More...
time_t	scheduled_end_time
	the time the scheduled event will end, or null if the event does not have a scheduled time to end (may be empty) More...
event_privacy_level	privacy_level
	the privacy level of the scheduled event More...
event_status	status
	the status of the scheduled event More...
event_entity_type	entity_type
	the type of hosting entity associated with a scheduled event, e.g. voice channel or stage channel More...
snowflake	entity_id
	any additional id of the hosting entity associated with event, e.g. stage instance id) (may be empty) More...
event_entities	entity_metadata
	the entity metadata for the scheduled event (may be empty) More...
user	creator
	Optional: the creator of the scheduled event. More...
uint32_t	user_count
	Optional: the number of users subscribed to the scheduled event. More...

Detailed Description

A scheduled event.

Constructor & Destructor Documentation

scheduled_event()

dpp::scheduled_event::scheduled_event

(

)

Create a scheduled_event object.

~scheduled_event()

dpp::scheduled_event::~scheduled_event ( )

default

Destroy the scheduled_event object.

Member Function Documentation

build_json()

std::string const dpp::scheduled_event::build_json

(

bool

with_id = false

)

const

Build json for this object.

Parameters

with_id

Include id field in json

Returns

std::string Dumped json of this object

clear_description()

scheduled_event & dpp::scheduled_event::clear_description

(

)

Clear the description of the event.

Returns

scheduled_event& reference to self

fill_from_json()

scheduled_event & dpp::scheduled_event::fill_from_json

(

const nlohmann::json *

j

)

Serialise a scheduled_event object from json.

Returns

scheduled_event& a reference to self

set_channel_id()

scheduled_event & dpp::scheduled_event::set_channel_id

(

snowflake

c

)

Set the voice channel id of the event.

Note

clears location

Parameters

c	channel ID

Returns

scheduled_event& reference to self

set_creator_id()

scheduled_event & dpp::scheduled_event::set_creator_id

(

snowflake

c

)

Set the creator id of the event.

Parameters

c	creator user ID

Returns

scheduled_event& reference to self

set_description()

scheduled_event & dpp::scheduled_event::set_description

(

const std::string &

d

)

Set the description of the event Minimum length: 1 (if set), Maximum length: 100.

Parameters

d	event description

Returns

scheduled_event& reference to self

Exceptions

dpp::length_error

if length < 1

set_end_time()

scheduled_event & dpp::scheduled_event::set_end_time

(

time_t

t

)

Set the end time of the event.

Parameters

t	ending time

Returns

scheduled_event& reference to self

Exceptions

dpp::length_error

if time is before now

set_location()

scheduled_event & dpp::scheduled_event::set_location

(

const std::string &

l

)

Set the location of the event. Minimum length: 1, Maximum length: 1000.

Note

Clears channel_id

Parameters

l	event location

Returns

scheduled_event& reference to self

Exceptions

dpp::length_error

if length < 1

set_name()

scheduled_event & dpp::scheduled_event::set_name

(

const std::string &

n

)

Set the name of the event Minimum length: 1, Maximum length: 100.

Parameters

n	event name

Returns

scheduled_event& reference to self

Exceptions

dpp::length_error

if length < 1

set_start_time()

scheduled_event & dpp::scheduled_event::set_start_time

(

time_t

t

)

Set the start time of the event.

Parameters

t	starting time

Returns

scheduled_event& reference to self

Exceptions

dpp::length_error

if time is before now

set_status()

scheduled_event & dpp::scheduled_event::set_status

(

event_status

s

)

Set the status of the event.

Parameters

s	status to set

Returns

scheduled_event& reference to self

Exceptions

dpp::logic_error

if status change is not valid

Member Data Documentation

channel_id

snowflake dpp::scheduled_event::channel_id

the channel id in which the scheduled event will be hosted, or null if scheduled entity type is EXTERNAL (may be empty)

creator

user dpp::scheduled_event::creator

Optional: the creator of the scheduled event.

creator_id

snowflake dpp::scheduled_event::creator_id

Optional: the id of the user that created the scheduled event.

description

std::string dpp::scheduled_event::description

Optional: the description of the scheduled event.

entity_id

snowflake dpp::scheduled_event::entity_id

any additional id of the hosting entity associated with event, e.g. stage instance id) (may be empty)

entity_metadata

event_entities dpp::scheduled_event::entity_metadata

the entity metadata for the scheduled event (may be empty)

entity_type

event_entity_type dpp::scheduled_event::entity_type

the type of hosting entity associated with a scheduled event, e.g. voice channel or stage channel

guild_id

snowflake dpp::scheduled_event::guild_id

the guild id which the scheduled event belongs to

id

snowflake dpp::scheduled_event::id

the id of the scheduled event

image

std::string dpp::scheduled_event::image

the image of the scheduled event (may be empty)

name

std::string dpp::scheduled_event::name

the name of the scheduled event

privacy_level

event_privacy_level dpp::scheduled_event::privacy_level

the privacy level of the scheduled event

scheduled_end_time

time_t dpp::scheduled_event::scheduled_end_time

the time the scheduled event will end, or null if the event does not have a scheduled time to end (may be empty)

scheduled_start_time

time_t dpp::scheduled_event::scheduled_start_time

the time the scheduled event will start

status

event_status dpp::scheduled_event::status

the status of the scheduled event

user_count

uint32_t dpp::scheduled_event::user_count

Optional: the number of users subscribed to the scheduled event.