D++ (DPP)
C++ Discord API Bot Library
dpp::scheduled_event Struct Reference

A scheduled event. More...

#include <scheduled_event.h>

+ Inheritance diagram for dpp::scheduled_event:
+ 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_eventset_name (const std::string &n)
 Set the name of the event Minimum length: 1, Maximum length: 100. More...
 
scheduled_eventset_description (const std::string &d)
 Set the description of the event Minimum length: 1 (if set), Maximum length: 100. More...
 
scheduled_eventclear_description ()
 Clear the description of the event. More...
 
scheduled_eventset_location (const std::string &l)
 Set the location of the event. Minimum length: 1, Maximum length: 1000. More...
 
scheduled_eventset_channel_id (snowflake c)
 Set the voice channel id of the event. More...
 
scheduled_eventset_creator_id (snowflake c)
 Set the creator id of the event. More...
 
scheduled_eventset_status (event_status s)
 Set the status of the event. More...
 
scheduled_eventset_start_time (time_t t)
 Set the start time of the event. More...
 
scheduled_eventset_end_time (time_t t)
 Set the end time of the event. More...
 
scheduled_eventfill_from_json (const nlohmann::json *j)
 Serialise a scheduled_event object from json. More...
 
virtual std::string build_json (bool with_id=false) const
 Build json for this object. More...
 
double get_creation_time () const
 Get the creation time of this object according to Discord. More...
 
bool operator== (const managed &other) const noexcept
 Comparison operator for comparing two managed objects by id. More...
 
bool operator!= (const managed &other) const noexcept
 Comparison operator for comparing two managed objects by id. More...
 
scheduled_eventfill_from_json (nlohmann::json *j)
 Convert object from nlohmann::json. More...
 

Public Attributes

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 (1-1000 characters) 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...
 
snowflake id
 Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata. 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()

virtual std::string dpp::scheduled_event::build_json ( bool  with_id = false) const
virtual

Build json for this object.

Parameters
with_idInclude id field in json
Returns
std::string Dumped json of this object

Reimplemented from dpp::json_interface< scheduled_event >.

◆ clear_description()

scheduled_event & dpp::scheduled_event::clear_description ( )

Clear the description of the event.

Returns
scheduled_event& reference to self

◆ fill_from_json() [1/2]

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

◆ fill_from_json() [2/2]

scheduled_event & dpp::json_interface< scheduled_event >::fill_from_json ( nlohmann::json *  j)
inlineinherited

Convert object from nlohmann::json.

Parameters
jnlohmann::json object
Returns
T& Reference to self for fluent calling

◆ get_creation_time()

double dpp::managed::get_creation_time ( ) const
inherited

Get the creation time of this object according to Discord.

Returns
double creation time inferred from the snowflake ID. The minimum possible value is the first second of 2015.

◆ operator!=()

bool dpp::managed::operator!= ( const managed other) const
noexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters
otherOther object to compare against
Returns
true objects are not the same id
false objects are the same id

◆ operator==()

bool dpp::managed::operator== ( const managed other) const
noexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters
otherOther object to compare against
Returns
true objects are the same id
false objects are not the same id

◆ 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
cchannel 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
ccreator 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
devent description
Returns
scheduled_event& reference to self
Exceptions
dpp::length_errorif length < 1

◆ set_end_time()

scheduled_event & dpp::scheduled_event::set_end_time ( time_t  t)

Set the end time of the event.

Parameters
tending time
Returns
scheduled_event& reference to self
Exceptions
dpp::length_errorif 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
levent location
Returns
scheduled_event& reference to self
Exceptions
dpp::length_errorif 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
nevent name
Returns
scheduled_event& reference to self
Exceptions
dpp::length_errorif length < 1

◆ set_start_time()

scheduled_event & dpp::scheduled_event::set_start_time ( time_t  t)

Set the start time of the event.

Parameters
tstarting time
Returns
scheduled_event& reference to self
Exceptions
dpp::length_errorif time is before now

◆ set_status()

scheduled_event & dpp::scheduled_event::set_status ( event_status  s)

Set the status of the event.

Parameters
sstatus to set
Returns
scheduled_event& reference to self
Exceptions
dpp::logic_errorif 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 (1-1000 characters)

◆ 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::managed::id
inherited

Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata.

◆ 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.

D++ Library version 10.0.29D++ Library version 10.0.28D++ Library version 10.0.27D++ Library version 10.0.26D++ Library version 10.0.25D++ Library version 10.0.24D++ Library version 10.0.23D++ Library version 10.0.22D++ Library version 10.0.21D++ Library version 10.0.20D++ Library version 10.0.19D++ Library version 10.0.18D++ Library version 10.0.17D++ Library version 10.0.16D++ Library version 10.0.15D++ Library version 10.0.14D++ Library version 10.0.13D++ Library version 10.0.12D++ Library version 10.0.11D++ Library version 10.0.10D++ Library version 10.0.9D++ Library version 10.0.8D++ Library version 10.0.7D++ Library version 10.0.6D++ Library version 10.0.5D++ Library version 10.0.4D++ Library version 10.0.3D++ Library version 10.0.2D++ Library version 10.0.1D++ Library version 10.0.0D++ Library version 9.0.19D++ Library version 9.0.18D++ Library version 9.0.17D++ Library version 9.0.16D++ Library version 9.0.15D++ Library version 9.0.14D++ Library version 9.0.13D++ Library version 9.0.12D++ Library version 9.0.11D++ Library version 9.0.10D++ Library version 9.0.9D++ Library version 9.0.8D++ Library version 9.0.7D++ Library version 9.0.6D++ Library version 9.0.5D++ Library version 9.0.4D++ Library version 9.0.3D++ Library version 9.0.2D++ Library version 9.0.1D++ Library version 9.0.0D++ Library version 1.0.2D++ Library version 1.0.1D++ Library version 1.0.0