DiscordCoreAPI::GuildScheduledEvents Class Reference

An interface class for the GuildScheduledEvent related Discord endpoints. More...

#include <GuildScheduledEventEntities.hpp>

Static Public Member Functions
static CoRoutine< GuildScheduledEvent >	createGuildScheduledEventAsync (CreateGuildScheduledEventData dataPackage)
	Creates a new GuildScheduledEvent within a chosen Guild.
static CoRoutine< void >	deleteGuildScheduledEventAsync (DeleteGuildScheduledEventData dataPackage)
	Deletes a single GuildScheduledEvent.
static CoRoutine< GuildScheduledEvent >	getGuildScheduledEventAsync (GetGuildScheduledEventData dataPackage)
	Collects a single GuildScheduledEvent.
static CoRoutine< std::vector< GuildScheduledEvent > >	getGuildScheduledEventsAsync (GetGuildScheduledEventsData dataPackage)
	Gets a list of a given Guild's scheduled events.
static CoRoutine< std::vector< GuildScheduledEventUserData > >	getGuildScheduledEventUsersAsync (GetGuildScheduledEventUsersData dataPackage)
	Collects a list of Users for a given GuildScheduledEvent.
static CoRoutine< GuildScheduledEvent >	modifyGuildScheduledEventAsync (ModifyGuildScheduledEventData dataPackage)
	Modifies a single GuildScheduledEvent.

Member Function Documentation

createGuildScheduledEventAsync()

CoRoutine< GuildScheduledEvent > DiscordCoreAPI::GuildScheduledEvents::createGuildScheduledEventAsync ( CreateGuildScheduledEventData  dataPackage )

static

Parameters

dataPackage

A CreateGuildScheduledEventData structure.

Returns

A CoRoutine containing a GuildScheduledEvent.

Definition at line 134 of file GuildScheduledEventEntities.cpp.

deleteGuildScheduledEventAsync()

CoRoutine< void > DiscordCoreAPI::GuildScheduledEvents::deleteGuildScheduledEventAsync ( DeleteGuildScheduledEventData  dataPackage )

static

Parameters

dataPackage

A DeleteGuildScheduledEventData structure.

Returns

A CoRoutine containing void.

Definition at line 174 of file GuildScheduledEventEntities.cpp.

getGuildScheduledEventAsync()

CoRoutine< GuildScheduledEvent > DiscordCoreAPI::GuildScheduledEvents::getGuildScheduledEventAsync ( GetGuildScheduledEventData  dataPackage )

static

Parameters

dataPackage

A GetGuildScheduledEventData structure.

Returns

A CoRoutine containing a GuildScheduledEvent.

Definition at line 147 of file GuildScheduledEventEntities.cpp.

getGuildScheduledEventsAsync()

CoRoutine< std::vector< GuildScheduledEvent > > DiscordCoreAPI::GuildScheduledEvents::getGuildScheduledEventsAsync ( GetGuildScheduledEventsData  dataPackage )

static

Parameters

dataPackage

A GetGuildScheduledEventsstructure.

Returns

A CoRoutine containing a vector<GuildScheduledEvent>.

Definition at line 123 of file GuildScheduledEventEntities.cpp.

getGuildScheduledEventUsersAsync()

CoRoutine< std::vector< GuildScheduledEventUserData > > DiscordCoreAPI::GuildScheduledEvents::getGuildScheduledEventUsersAsync ( GetGuildScheduledEventUsersData  dataPackage )

static

Parameters

dataPackage

A GetGuildScheduledEventUsersData structure.

Returns

A CoRoutine containing a vector<GuildScheduledEventUser>.

Definition at line 183 of file GuildScheduledEventEntities.cpp.

modifyGuildScheduledEventAsync()

CoRoutine< GuildScheduledEvent > DiscordCoreAPI::GuildScheduledEvents::modifyGuildScheduledEventAsync ( ModifyGuildScheduledEventData  dataPackage )

static

Parameters

dataPackage

A ModifyGuildScheduledEventData structure.

Returns

A CoRoutine containing a GuildScheduledEvent.

Definition at line 161 of file GuildScheduledEventEntities.cpp.

---

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

• GuildScheduledEventEntities.hpp
• GuildScheduledEventEntities.cpp