discord_core_api::guild_scheduled_events Class Reference

An interface class for the guild_scheduled_event_data related discord endpoints. More...

#include <GuildScheduledEventEntities.hpp>

Static Public Member Functions
static co_routine< guild_scheduled_event_data >	createGuildScheduledEventAsync (const create_guild_scheduled_event_data dataPackage)
	Creates a new guild_scheduled_event_data within a chosen guild. More...
static co_routine< void >	deleteGuildScheduledEventAsync (const delete_guild_scheduled_event_data dataPackage)
	Deletes a single guild_scheduled_event_data. More...
static co_routine< guild_scheduled_event_data >	getGuildScheduledEventAsync (const get_guild_scheduled_event_data dataPackage)
	Collects a single guild_scheduled_event_data. More...
static co_routine< jsonifier::vector< guild_scheduled_event_data > >	getGuildScheduledEventsAsync (const get_guild_scheduled_events_data dataPackage)
	Gets a list of a given guild's scheduled events. More...
static co_routine< jsonifier::vector< guild_scheduled_event_user_data > >	getGuildScheduledEventUsersAsync (const get_guild_scheduled_event_users_data dataPackage)
	Collects a list of users for a given guild_scheduled_event_data. More...
static co_routine< guild_scheduled_event_data >	modifyGuildScheduledEventAsync (const modify_guild_scheduled_event_data dataPackage)
	Modifies a single guild_scheduled_event_data. More...

Member Function Documentation

createGuildScheduledEventAsync()

co_routine< guild_scheduled_event_data > discord_core_api::guild_scheduled_events::createGuildScheduledEventAsync ( const create_guild_scheduled_event_data  dataPackage )

static

Parameters

dataPackage

a create_guild_scheduled_event_data structure.

Returns

a co_routine containing a guild_scheduled_event_data.

Definition at line 71 of file GuildScheduledEventEntities.cpp.

deleteGuildScheduledEventAsync()

co_routine< void > discord_core_api::guild_scheduled_events::deleteGuildScheduledEventAsync ( const delete_guild_scheduled_event_data  dataPackage )

static

Parameters

dataPackage

a delete_guild_scheduled_event_data structure.

Returns

a co_routine containing void.

Definition at line 110 of file GuildScheduledEventEntities.cpp.

getGuildScheduledEventAsync()

co_routine< guild_scheduled_event_data > discord_core_api::guild_scheduled_events::getGuildScheduledEventAsync ( const get_guild_scheduled_event_data  dataPackage )

static

Parameters

dataPackage

a get_guild_scheduled_event_data structure.

Returns

a co_routine containing a guild_scheduled_event_data.

Definition at line 83 of file GuildScheduledEventEntities.cpp.

getGuildScheduledEventsAsync()

co_routine< jsonifier::vector< guild_scheduled_event_data > > discord_core_api::guild_scheduled_events::getGuildScheduledEventsAsync ( const get_guild_scheduled_events_data  dataPackage )

static

Parameters

dataPackage

a get_guild_scheduled_eventsstructure.

Returns

a co_routine containing a vector<guild_scheduled_event_data>.

Definition at line 60 of file GuildScheduledEventEntities.cpp.

getGuildScheduledEventUsersAsync()

co_routine< jsonifier::vector< guild_scheduled_event_user_data > > discord_core_api::guild_scheduled_events::getGuildScheduledEventUsersAsync ( const get_guild_scheduled_event_users_data  dataPackage )

static

Parameters

dataPackage

a get_guild_scheduled_event_users_data structure.

Returns

a co_routine containing a vector<guild_scheduled_event_user>.

Definition at line 120 of file GuildScheduledEventEntities.cpp.

modifyGuildScheduledEventAsync()

co_routine< guild_scheduled_event_data > discord_core_api::guild_scheduled_events::modifyGuildScheduledEventAsync ( const modify_guild_scheduled_event_data  dataPackage )

static

Parameters

dataPackage

a modify_guild_scheduled_event_data structure.

Returns

a co_routine containing a guild_scheduled_event_data.

Definition at line 98 of file GuildScheduledEventEntities.cpp.

---

The documentation for this class was generated from the following files:

• GuildScheduledEventEntities.hpp
• GuildScheduledEventEntities.cpp