DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
Loading...
Searching...
No Matches
DiscordCoreAPI::GuildScheduledEvents Class Reference

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

#include <GuildScheduledEventEntities.hpp>

Static Public Member Functions

static CoRoutine< GuildScheduledEventcreateGuildScheduledEventAsync (CreateGuildScheduledEventData dataPackage)
 Creates a new GuildScheduledEvent within a chosen Guild. More...
 
static CoRoutine< void > deleteGuildScheduledEventAsync (DeleteGuildScheduledEventData dataPackage)
 Deletes a single GuildScheduledEvent. More...
 
static CoRoutine< GuildScheduledEventgetGuildScheduledEventAsync (GetGuildScheduledEventData dataPackage)
 Collects a single GuildScheduledEvent. More...
 
static CoRoutine< std::vector< GuildScheduledEvent > > getGuildScheduledEventsAsync (GetGuildScheduledEventsData dataPackage)
 Gets a list of a given Guild's scheduled events. More...
 
static CoRoutine< std::vector< GuildScheduledEventUserData > > getGuildScheduledEventUsersAsync (GetGuildScheduledEventUsersData dataPackage)
 Collects a list of Users for a given GuildScheduledEvent. More...
 
static CoRoutine< GuildScheduledEventmodifyGuildScheduledEventAsync (ModifyGuildScheduledEventData dataPackage)
 Modifies a single GuildScheduledEvent. More...
 

Member Function Documentation

◆ createGuildScheduledEventAsync()

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

Creates a new GuildScheduledEvent within a chosen Guild.

Parameters
dataPackageA 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

Deletes a single GuildScheduledEvent.

Parameters
dataPackageA DeleteGuildScheduledEventData structure.
Returns
A CoRoutine containing void.

Definition at line 167 of file GuildScheduledEventEntities.cpp.

◆ getGuildScheduledEventAsync()

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

Collects a single GuildScheduledEvent.

Parameters
dataPackageA GetGuildScheduledEventData structure.
Returns
A CoRoutine containing a GuildScheduledEvent.

Definition at line 144 of file GuildScheduledEventEntities.cpp.

◆ getGuildScheduledEventsAsync()

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

Gets a list of a given Guild's scheduled events.

Parameters
dataPackageA GetGuildScheduledEventsDatastructure.
Returns
A CoRoutine containing a vector<GuildScheduledEvent>.

Definition at line 125 of file GuildScheduledEventEntities.cpp.

◆ getGuildScheduledEventUsersAsync()

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

Collects a list of Users for a given GuildScheduledEvent.

Parameters
dataPackageA GetGuildScheduledEventUsersData structure.
Returns
A CoRoutine containing a vector<GuildScheduledEventUser>.

Definition at line 176 of file GuildScheduledEventEntities.cpp.

◆ modifyGuildScheduledEventAsync()

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

Modifies a single GuildScheduledEvent.

Parameters
dataPackageA ModifyGuildScheduledEventData structure.
Returns
A CoRoutine containing a GuildScheduledEvent.

Definition at line 157 of file GuildScheduledEventEntities.cpp.


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