![]() |
D++ (DPP)
C++ Discord API Bot Library
|
A scheduled event. More...
#include <scheduled_event.h>
Public Member Functions | |
scheduled_event () | |
Create a 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 & | load_image (std::string_view image_blob, const image_type type) |
Load an image for the event cover. More... | |
scheduled_event & | load_image (const std::byte *data, uint32_t size, const image_type type) |
Load an image for the event cover. More... | |
constexpr double | get_creation_time () const noexcept |
Get the creation time of this object according to Discord. More... | |
constexpr bool | operator== (const managed &other) const noexcept |
Comparison operator for comparing two managed objects by id. More... | |
constexpr bool | operator!= (const managed &other) const noexcept |
Comparison operator for comparing two managed objects by id. More... | |
scheduled_event & | fill_from_json (nlohmann::json *j) |
Convert object from nlohmann::json. More... | |
auto | to_json (bool with_id=false) const |
Convert object to nlohmann::json. More... | |
std::string | build_json (bool with_id=false) const |
Convert object to json string. 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... | |
utility::icon | 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... | |
Protected Member Functions | |
scheduled_event & | fill_from_json_impl (const nlohmann::json *j) |
Serialise a scheduled_event object from json. More... | |
json | to_json_impl (bool with_id=false) const |
Build json for this object. More... | |
Friends | |
struct | json_interface< scheduled_event > |
A scheduled event.
dpp::scheduled_event::scheduled_event | ( | ) |
Create a scheduled_event object.
|
inlineinherited |
Convert object to json string.
with_id | Whether to include the ID or not |
scheduled_event & dpp::scheduled_event::clear_description | ( | ) |
Clear the description of the event.
|
inlineinherited |
Convert object from nlohmann::json.
j | nlohmann::json object |
|
protected |
Serialise a scheduled_event object from json.
|
inlineconstexprnoexceptinherited |
Get the creation time of this object according to Discord.
scheduled_event & dpp::scheduled_event::load_image | ( | const std::byte * | data, |
uint32_t | size, | ||
const image_type | type | ||
) |
Load an image for the event cover.
image_blob | Image binary data |
type | Type of image. It can be one of i_gif , i_jpg or i_png . |
scheduled_event & dpp::scheduled_event::load_image | ( | std::string_view | image_blob, |
const image_type | type | ||
) |
Load an image for the event cover.
image_blob | Image binary data |
type | Type of image. It can be one of i_gif , i_jpg or i_png . |
|
inlineconstexprnoexceptinherited |
Comparison operator for comparing two managed objects by id.
other | Other object to compare against |
|
inlineconstexprnoexceptinherited |
Comparison operator for comparing two managed objects by id.
other | Other object to compare against |
scheduled_event & dpp::scheduled_event::set_channel_id | ( | snowflake | c | ) |
Set the voice channel id of the event.
c | channel ID |
scheduled_event & dpp::scheduled_event::set_creator_id | ( | snowflake | c | ) |
Set the creator id of the event.
c | creator user ID |
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.
d | event description |
dpp::length_error | if length < 1 |
scheduled_event & dpp::scheduled_event::set_end_time | ( | time_t | t | ) |
Set the end time of the event.
t | ending time |
dpp::length_error | if time is before now |
scheduled_event & dpp::scheduled_event::set_location | ( | const std::string & | l | ) |
Set the location of the event. Minimum length: 1, Maximum length: 1000.
l | event location |
dpp::length_error | if length < 1 |
scheduled_event & dpp::scheduled_event::set_name | ( | const std::string & | n | ) |
Set the name of the event Minimum length: 1, Maximum length: 100.
n | event name |
dpp::length_error | if length < 1 |
scheduled_event & dpp::scheduled_event::set_start_time | ( | time_t | t | ) |
Set the start time of the event.
t | starting time |
dpp::length_error | if time is before now |
scheduled_event & dpp::scheduled_event::set_status | ( | event_status | s | ) |
Set the status of the event.
s | status to set |
dpp::logic_exception | if status change is not valid |
|
inlineinherited |
Convert object to nlohmann::json.
with_id | Whether to include the ID or not |
|
protected |
Build json for this object.
with_id | Include id field in json |
|
friend |
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)
user dpp::scheduled_event::creator |
Optional: the creator of the scheduled event.
snowflake dpp::scheduled_event::creator_id |
Optional: the id of the user that created the scheduled event.
std::string dpp::scheduled_event::description |
Optional: the description of the scheduled event (1-1000 characters)
snowflake dpp::scheduled_event::entity_id |
any additional id of the hosting entity associated with event, e.g. stage instance id) (may be empty)
event_entities dpp::scheduled_event::entity_metadata |
the entity metadata for the scheduled event (may be empty)
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
snowflake dpp::scheduled_event::guild_id |
the guild id which the scheduled event belongs to
|
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.
utility::icon dpp::scheduled_event::image |
the image of the scheduled event (may be empty)
std::string dpp::scheduled_event::name |
the name of the scheduled event
event_privacy_level dpp::scheduled_event::privacy_level |
the privacy level of the scheduled event
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)
time_t dpp::scheduled_event::scheduled_start_time |
the time the scheduled event will start
event_status dpp::scheduled_event::status |
the status of the scheduled event
uint32_t dpp::scheduled_event::user_count |
Optional: the number of users subscribed to the scheduled event.