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

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

#include <GuildEntities.hpp>

Static Public Member Functions

static CoRoutine< GuildPruneCountDatabeginGuildPruneAsync (BeginGuildPruneData dataPackage)
 For performing a pruning of the GuildMembers of the Guild, based on days of inactivity.
 
static CoRoutine< GuildcreateGuildAsync (CreateGuildData dataPackage)
 Creates a new Guild.
 
static CoRoutine< void > createGuildBanAsync (CreateGuildBanData dataPackage)
 Bans a GuildMember.
 
static CoRoutine< GuildcreateGuildFromGuildTemplateAsync (CreateGuildFromGuildTemplateData dataPackage)
 Creates a Guild from the Guild Template.
 
static CoRoutine< GuildTemplateDatacreateGuildTemplateAsync (CreateGuildTemplateData dataPackage)
 Creates a Guild Template.
 
static CoRoutine< void > deleteGuildAsync (DeleteGuildData dataPackage)
 Deletes a chosen Guild.
 
static CoRoutine< void > deleteGuildIntegrationAsync (DeleteGuildIntegrationData dataPackage)
 Deletes an integration from a Guild.
 
static CoRoutine< void > deleteGuildTemplateAsync (DeleteGuildTemplateData dataPackage)
 Deletes a Guild Template.
 
static CoRoutine< void > deleteInviteAsync (DeleteInviteData dataPackage)
 Deletes an invite from the Discord servers.
 
static CoRoutine< std::vector< GuildData > > getAllGuildsAsync ()
 Returns all of the Guilds that the current bot is in.
 
static GuildData getCachedGuild (GetGuildData dataPackage)
 Collects a Guild from the library's cache.
 
static CoRoutine< std::vector< Guild > > getCurrentUserGuildsAsync (GetCurrentUserGuildsData dataPackage)
 Collects a list of Guilds that the Bot is in.
 
static CoRoutine< GuildgetGuildAsync (GetGuildData dataPackage)
 Collects a Guild from the Discord servers.
 
static CoRoutine< AuditLogDatagetGuildAuditLogsAsync (GetGuildAuditLogsData dataPackage)
 Gets an audit log from the Discord servers.
 
static CoRoutine< BanDatagetGuildBanAsync (GetGuildBanData dataPackage)
 Collects a single Ban from a chosen Guild.
 
static CoRoutine< std::vector< BanData > > getGuildBansAsync (GetGuildBansData dataPackage)
 Collects a list of Bans from a chosen Guild.
 
static CoRoutine< std::vector< IntegrationData > > getGuildIntegrationsAsync (GetGuildIntegrationsData dataPackage)
 Gets the list of Guild integrations for a particular server.
 
static CoRoutine< std::vector< InviteData > > getGuildInvitesAsync (GetGuildInvitesData dataPackage)
 Gets multiple invites from the Discord servers.
 
static CoRoutine< GuildPreviewDatagetGuildPreviewAsync (GetGuildPreviewData dataPackage)
 Acquires the preview Data of a chosen Guild.
 
static CoRoutine< GuildPruneCountDatagetGuildPruneCountAsync (GetGuildPruneCountData dataPackage)
 For collecting the Guild prune count.
 
static CoRoutine< GuildTemplateDatagetGuildTemplateAsync (GetGuildTemplateData dataPackage)
 Gets the Guild Template from a particular server.
 
static CoRoutine< std::vector< GuildTemplateData > > getGuildTemplatesAsync (GetGuildTemplatesData dataPackage)
 Collects a list of Guild Templates from a chosen Guild.
 
static CoRoutine< InviteDatagetGuildVanityInviteAsync (GetGuildVanityInviteData dataPackage)
 Gets the vanity invite responseData from a particular server.
 
static CoRoutine< std::vector< VoiceRegionData > > getGuildVoiceRegionsAsync (GetGuildVoiceRegionsData dataPackage)
 Gets the list of voice regions for a particular server.
 
static CoRoutine< WelcomeScreenDatagetGuildWelcomeScreenAsync (GetGuildWelcomeScreenData dataPackage)
 Gets the Guild welcome screen for a particular server.
 
static CoRoutine< GuildWidgetDatagetGuildWidgetAsync (GetGuildWidgetData dataPackage)
 Gets the Guild widget for a particular server.
 
static CoRoutine< GuildWidgetImageDatagetGuildWidgetImageAsync (GetGuildWidgetImageData dataPackage)
 Gets the Guild widget image for a particular server.
 
static CoRoutine< GuildWidgetDatagetGuildWidgetSettingsAsync (GetGuildWidgetSettingsData dataPackage)
 Gets the Guild widget's settings for a particular server.
 
static CoRoutine< InviteDatagetInviteAsync (GetInviteData dataPackage)
 Gets an invite from the Discord servers.
 
static CoRoutine< void > leaveGuildAsync (LeaveGuildData dataPackage)
 Removes the bot from a chosen Guild.
 
static CoRoutine< GuildmodifyGuildAsync (ModifyGuildData dataPackage)
 Modifies a chosen Guild's properties.
 
static CoRoutine< GuildTemplateDatamodifyGuildTemplateAsync (ModifyGuildTemplateData dataPackage)
 Modifies a Guild Template.
 
static CoRoutine< WelcomeScreenDatamodifyGuildWelcomeScreenAsync (ModifyGuildWelcomeScreenData dataPackage)
 Modifies the Guild welcome screen.
 
static CoRoutine< GuildWidgetDatamodifyGuildWidgetAsync (ModifyGuildWidgetData dataPackage)
 Modifies the Guild widget for a particular server.
 
static CoRoutine< void > removeGuildBanAsync (RemoveGuildBanData dataPackage)
 Removes a previously created ban.
 
static CoRoutine< GuildTemplateDatasyncGuildTemplateAsync (SyncGuildTemplateData dataPackage)
 Syncs a Guild Template.
 

Member Function Documentation

◆ beginGuildPruneAsync()

CoRoutine< GuildPruneCountData > DiscordCoreAPI::Guilds::beginGuildPruneAsync ( BeginGuildPruneData  dataPackage)
static
Parameters
dataPackageA BeginGuildPruneData structure.
Returns
A CoRoutine containing a GuildPruneCountData.

Definition at line 757 of file GuildEntities.cpp.

◆ createGuildAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::createGuildAsync ( CreateGuildData  dataPackage)
static
Parameters
dataPackageA CreateGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 569 of file GuildEntities.cpp.

◆ createGuildBanAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::createGuildBanAsync ( CreateGuildBanData  dataPackage)
static
Parameters
dataPackageA CreateGuildBanData structure.
Returns
A CoRoutine containing a BanData.

Definition at line 700 of file GuildEntities.cpp.

◆ createGuildFromGuildTemplateAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::createGuildFromGuildTemplateAsync ( CreateGuildFromGuildTemplateData  dataPackage)
static
Parameters
dataPackageA CreateGuildFromGuildTemplateData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 919 of file GuildEntities.cpp.

◆ createGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::createGuildTemplateAsync ( CreateGuildTemplateData  dataPackage)
static
Parameters
dataPackageA CreateGuildTemplateData structure.
Returns
A CoRoutine containing a GuiildTemplateData.

Definition at line 944 of file GuildEntities.cpp.

◆ deleteGuildAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteGuildAsync ( DeleteGuildData  dataPackage)
static
Parameters
dataPackageA DeleteGuildData structure.
Returns
A CoRoutine containing void.

Definition at line 656 of file GuildEntities.cpp.

◆ deleteGuildIntegrationAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteGuildIntegrationAsync ( DeleteGuildIntegrationData  dataPackage)
static
Parameters
dataPackageA DeleteGuildIntegrationData structure.
Returns
A CoRoutine containing void.

Definition at line 799 of file GuildEntities.cpp.

◆ deleteGuildTemplateAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteGuildTemplateAsync ( DeleteGuildTemplateData  dataPackage)
static
Parameters
dataPackageA DeleteGuildTemplateData structure.
Returns
A CoRoutine containing a void.

Definition at line 981 of file GuildEntities.cpp.

◆ deleteInviteAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteInviteAsync ( DeleteInviteData  dataPackage)
static
Parameters
dataPackageA DeleteInviteData structure.
Returns
A CoRoutine containing void.

Definition at line 1016 of file GuildEntities.cpp.

◆ getAllGuildsAsync()

CoRoutine< std::vector< GuildData > > DiscordCoreAPI::Guilds::getAllGuildsAsync ( )
static
Returns
A CoRoutine containing a GuildDataVector.

Definition at line 583 of file GuildEntities.cpp.

◆ getCachedGuild()

GuildData DiscordCoreAPI::Guilds::getCachedGuild ( GetGuildData  dataPackage)
static
Parameters
dataPackageA GetGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 610 of file GuildEntities.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCurrentUserGuildsAsync()

CoRoutine< std::vector< Guild > > DiscordCoreAPI::Guilds::getCurrentUserGuildsAsync ( GetCurrentUserGuildsData  dataPackage)
static
Parameters
dataPackageA GetCurrentUserGuildsData structure.
Returns
A CoRoutine containing a GuildVector.

Definition at line 1028 of file GuildEntities.cpp.

◆ getGuildAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::getGuildAsync ( GetGuildData  dataPackage)
static
Parameters
dataPackageA GetGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 593 of file GuildEntities.cpp.

Here is the caller graph for this function:

◆ getGuildAuditLogsAsync()

CoRoutine< AuditLogData > DiscordCoreAPI::Guilds::getGuildAuditLogsAsync ( GetGuildAuditLogsData  dataPackage)
static
Parameters
dataPackageA GetGuildAuditLogsData structure.
Returns
A CoRoutine containing an AuditLogData.

Definition at line 533 of file GuildEntities.cpp.

◆ getGuildBanAsync()

CoRoutine< BanData > DiscordCoreAPI::Guilds::getGuildBanAsync ( GetGuildBanData  dataPackage)
static
Parameters
dataPackageA GetGuildBanData structure.
Returns
A CoRoutine containing a BanData.

Definition at line 690 of file GuildEntities.cpp.

◆ getGuildBansAsync()

CoRoutine< std::vector< BanData > > DiscordCoreAPI::Guilds::getGuildBansAsync ( GetGuildBansData  dataPackage)
static
Parameters
dataPackageA GetGuildBansData structure.
Returns
A CoRoutine containing a BanDataVector.

Definition at line 665 of file GuildEntities.cpp.

◆ getGuildIntegrationsAsync()

CoRoutine< std::vector< IntegrationData > > DiscordCoreAPI::Guilds::getGuildIntegrationsAsync ( GetGuildIntegrationsData  dataPackage)
static
Parameters
dataPackageA GetGuildIntegrationsData structure.
Returns
A CoRoutine containing a IntegrationDataVector.

Definition at line 790 of file GuildEntities.cpp.

◆ getGuildInvitesAsync()

CoRoutine< std::vector< InviteData > > DiscordCoreAPI::Guilds::getGuildInvitesAsync ( GetGuildInvitesData  dataPackage)
static
Parameters
dataPackageA GetGuildInvitesData structure.
Returns
A CoRoutine containing a InviteDataVector.

Definition at line 781 of file GuildEntities.cpp.

◆ getGuildPreviewAsync()

CoRoutine< GuildPreviewData > DiscordCoreAPI::Guilds::getGuildPreviewAsync ( GetGuildPreviewData  dataPackage)
static
Parameters
dataPackageA GetGuildPreviewData structure.
Returns
A CoRoutine containing a GuildPreviewData.

Definition at line 624 of file GuildEntities.cpp.

◆ getGuildPruneCountAsync()

CoRoutine< GuildPruneCountData > DiscordCoreAPI::Guilds::getGuildPruneCountAsync ( GetGuildPruneCountData  dataPackage)
static
Parameters
dataPackageA GetGuildPruneCountData structure.
Returns
A CoRoutine containing GuildPruneCountData.

Definition at line 727 of file GuildEntities.cpp.

◆ getGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::getGuildTemplateAsync ( GetGuildTemplateData  dataPackage)
static
Parameters
dataPackageA GetGuildTemplateData structure.
Returns
A CoRoutine containing a GuildTemplateData.

Definition at line 910 of file GuildEntities.cpp.

◆ getGuildTemplatesAsync()

CoRoutine< std::vector< GuildTemplateData > > DiscordCoreAPI::Guilds::getGuildTemplatesAsync ( GetGuildTemplatesData  dataPackage)
static
Parameters
dataPackageA GetGuildTemplatesData structure.
Returns
A CoRoutine containing a GuiildTemplateDataVector.

Definition at line 935 of file GuildEntities.cpp.

◆ getGuildVanityInviteAsync()

CoRoutine< InviteData > DiscordCoreAPI::Guilds::getGuildVanityInviteAsync ( GetGuildVanityInviteData  dataPackage)
static
Parameters
dataPackageA GetGuildVanityInviteData structure.
Returns
A CoRoutine containing InviteData.

Definition at line 846 of file GuildEntities.cpp.

◆ getGuildVoiceRegionsAsync()

CoRoutine< std::vector< VoiceRegionData > > DiscordCoreAPI::Guilds::getGuildVoiceRegionsAsync ( GetGuildVoiceRegionsData  dataPackage)
static
Parameters
dataPackageA GetGuildVoiceRegionsData structure.
Returns
A CoRoutine containing a VoiceRegionDataVector.

Definition at line 772 of file GuildEntities.cpp.

◆ getGuildWelcomeScreenAsync()

CoRoutine< WelcomeScreenData > DiscordCoreAPI::Guilds::getGuildWelcomeScreenAsync ( GetGuildWelcomeScreenData  dataPackage)
static
Parameters
dataPackageA GetGuildWelcomeScreenData structure.
Returns
A CoRoutine containing a WelcomeScreenData.

Definition at line 886 of file GuildEntities.cpp.

◆ getGuildWidgetAsync()

CoRoutine< GuildWidgetData > DiscordCoreAPI::Guilds::getGuildWidgetAsync ( GetGuildWidgetData  dataPackage)
static
Parameters
dataPackageA GetGuildWidgetData structure.
Returns
A CoRoutine containing a GuildWidgetData.

Definition at line 837 of file GuildEntities.cpp.

◆ getGuildWidgetImageAsync()

CoRoutine< GuildWidgetImageData > DiscordCoreAPI::Guilds::getGuildWidgetImageAsync ( GetGuildWidgetImageData  dataPackage)
static
Parameters
dataPackageA GetGuildWidgetImageData structure.
Returns
A CoRoutine containing a GuildWidgetImageData.

Definition at line 855 of file GuildEntities.cpp.

◆ getGuildWidgetSettingsAsync()

CoRoutine< GuildWidgetData > DiscordCoreAPI::Guilds::getGuildWidgetSettingsAsync ( GetGuildWidgetSettingsData  dataPackage)
static
Parameters
dataPackageA GetGuildWidgetSettingsData structure.
Returns
A CoRoutine containing a GuildWidgetData.

Definition at line 811 of file GuildEntities.cpp.

◆ getInviteAsync()

CoRoutine< InviteData > DiscordCoreAPI::Guilds::getInviteAsync ( GetInviteData  dataPackage)
static
Parameters
dataPackageA GetInviteData structure.
Returns
A CoRoutine containing an InviteData.

Definition at line 990 of file GuildEntities.cpp.

◆ leaveGuildAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::leaveGuildAsync ( LeaveGuildData  dataPackage)
static
Parameters
dataPackageA LeaveGuildData structure.
Returns
A CoRoutine containing void.

Definition at line 1057 of file GuildEntities.cpp.

◆ modifyGuildAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::modifyGuildAsync ( ModifyGuildData  dataPackage)
static
Parameters
dataPackageA ModifyGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 633 of file GuildEntities.cpp.

◆ modifyGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::modifyGuildTemplateAsync ( ModifyGuildTemplateData  dataPackage)
static
Parameters
dataPackageA ModifyGuildTemplateData structure.
Returns
A CoRoutine containing a GuiildTemplateData.

Definition at line 967 of file GuildEntities.cpp.

◆ modifyGuildWelcomeScreenAsync()

CoRoutine< WelcomeScreenData > DiscordCoreAPI::Guilds::modifyGuildWelcomeScreenAsync ( ModifyGuildWelcomeScreenData  dataPackage)
static
Parameters
dataPackageA ModifyGuildWelcomeScreenData structure.
Returns
A CoRoutine containing a WelcomeScreenData.

Definition at line 895 of file GuildEntities.cpp.

◆ modifyGuildWidgetAsync()

CoRoutine< GuildWidgetData > DiscordCoreAPI::Guilds::modifyGuildWidgetAsync ( ModifyGuildWidgetData  dataPackage)
static
Parameters
dataPackageA ModifyGuildWidgetData structure.
Returns
A CoRoutine containing a GuildWidgetData.

Definition at line 820 of file GuildEntities.cpp.

◆ removeGuildBanAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::removeGuildBanAsync ( RemoveGuildBanData  dataPackage)
static
Parameters
dataPackageA RemoveGuildBanData structure.
Returns
A CoRoutine containing void.

Definition at line 715 of file GuildEntities.cpp.

◆ syncGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::syncGuildTemplateAsync ( SyncGuildTemplateData  dataPackage)
static
Parameters
dataPackageA SyncGuildTemplateData structure.
Returns
A CoRoutine containing a GuiildTemplateData.

Definition at line 958 of file GuildEntities.cpp.


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