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

Member Function Documentation

◆ beginGuildPruneAsync()

CoRoutine< GuildPruneCountData > DiscordCoreAPI::Guilds::beginGuildPruneAsync ( BeginGuildPruneData  dataPackage)
static

For performing a pruning of the GuildMembers of the Guild, based on days of inactivity.

Parameters
dataPackageA BeginGuildPruneData structure.
Returns
A CoRoutine containing a GuildPruneCountData.

Definition at line 775 of file GuildEntities.cpp.

◆ createGuildAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::createGuildAsync ( CreateGuildData  dataPackage)
static

Creates a new Guild.

Parameters
dataPackageA CreateGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 588 of file GuildEntities.cpp.

◆ createGuildBanAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::createGuildBanAsync ( CreateGuildBanData  dataPackage)
static

Bans a GuildMember.

Parameters
dataPackageA CreateGuildBanData structure.
Returns
A CoRoutine containing a BanData.

Definition at line 720 of file GuildEntities.cpp.

◆ createGuildFromGuildTemplateAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::createGuildFromGuildTemplateAsync ( CreateGuildFromGuildTemplateData  dataPackage)
static

Creates a Guild from the Guild Template.

Parameters
dataPackageA CreateGuildFromGuildTemplateData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 932 of file GuildEntities.cpp.

◆ createGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::createGuildTemplateAsync ( CreateGuildTemplateData  dataPackage)
static

Creates a Guild Template.

Parameters
dataPackageA CreateGuildTemplateData structure.
Returns
A CoRoutine containing a GuiildTemplateData.

Definition at line 956 of file GuildEntities.cpp.

◆ deleteGuildAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteGuildAsync ( DeleteGuildData  dataPackage)
static

Deletes a chosen Guild.

Parameters
dataPackageA DeleteGuildData structure.
Returns
A CoRoutine containing void.

Definition at line 676 of file GuildEntities.cpp.

◆ deleteGuildIntegrationAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteGuildIntegrationAsync ( DeleteGuildIntegrationData  dataPackage)
static

Deletes an integration from a Guild.

Parameters
dataPackageA DeleteGuildIntegrationData structure.
Returns
A CoRoutine containing void.

Definition at line 815 of file GuildEntities.cpp.

◆ deleteGuildTemplateAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteGuildTemplateAsync ( DeleteGuildTemplateData  dataPackage)
static

Deletes a Guild Template.

Parameters
dataPackageA DeleteGuildTemplateData structure.
Returns
A CoRoutine containing a void.

Definition at line 991 of file GuildEntities.cpp.

◆ deleteInviteAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::deleteInviteAsync ( DeleteInviteData  dataPackage)
static

Deletes an invite from the Discord servers.

Parameters
dataPackageA DeleteInviteData structure.
Returns
A CoRoutine containing void.

Definition at line 1026 of file GuildEntities.cpp.

◆ getAllGuildsAsync()

CoRoutine< std::vector< GuildData > > DiscordCoreAPI::Guilds::getAllGuildsAsync ( )
static

Returns all of the Guilds that the current bot is in.

Returns
A CoRoutine containing a GuildDataVector.

Definition at line 600 of file GuildEntities.cpp.

◆ getCachedGuildAsync()

CoRoutine< GuildData > DiscordCoreAPI::Guilds::getCachedGuildAsync ( GetGuildData  dataPackage)
static

Collects a Guild from the library's cache.

Parameters
dataPackageA GetGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 629 of file GuildEntities.cpp.

Here is the call graph for this function:

◆ getCurrentUserGuildsAsync()

CoRoutine< std::vector< Guild > > DiscordCoreAPI::Guilds::getCurrentUserGuildsAsync ( GetCurrentUserGuildsData  dataPackage)
static

Collects a list of Guilds that the Bot is in.

Parameters
dataPackageA GetCurrentUserGuildsData structure.
Returns
A CoRoutine containing a GuildVector.

Definition at line 1038 of file GuildEntities.cpp.

◆ getGuildAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::getGuildAsync ( GetGuildData  dataPackage)
static

Collects a Guild from the Discord servers.

Parameters
dataPackageA GetGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 610 of file GuildEntities.cpp.

Here is the caller graph for this function:

◆ getGuildAuditLogsAsync()

CoRoutine< AuditLogData > DiscordCoreAPI::Guilds::getGuildAuditLogsAsync ( GetGuildAuditLogsData  dataPackage)
static

Gets an audit log from the Discord servers.

Parameters
dataPackageA GetGuildAuditLogsData structure.
Returns
A CoRoutine containing an AuditLogData.

Definition at line 552 of file GuildEntities.cpp.

◆ getGuildBanAsync()

CoRoutine< BanData > DiscordCoreAPI::Guilds::getGuildBanAsync ( GetGuildBanData  dataPackage)
static

Collects a single Ban from a chosen Guild.

Parameters
dataPackageA GetGuildBanData structure.
Returns
A CoRoutine containing a BanData.

Definition at line 710 of file GuildEntities.cpp.

◆ getGuildBansAsync()

CoRoutine< std::vector< BanData > > DiscordCoreAPI::Guilds::getGuildBansAsync ( GetGuildBansData  dataPackage)
static

Collects a list of Bans from a chosen Guild.

Parameters
dataPackageA GetGuildBansData structure.
Returns
A CoRoutine containing a BanDataVector.

Definition at line 685 of file GuildEntities.cpp.

◆ getGuildIntegrationsAsync()

CoRoutine< std::vector< IntegrationData > > DiscordCoreAPI::Guilds::getGuildIntegrationsAsync ( GetGuildIntegrationsData  dataPackage)
static

Gets the list of Guild integrations for a particular server.

Parameters
dataPackageA GetGuildIntegrationsData structure.
Returns
A CoRoutine containing a IntegrationDataVector.

Definition at line 806 of file GuildEntities.cpp.

◆ getGuildInvitesAsync()

CoRoutine< std::vector< InviteData > > DiscordCoreAPI::Guilds::getGuildInvitesAsync ( GetGuildInvitesData  dataPackage)
static

Gets multiple invites from the Discord servers.

Parameters
dataPackageA GetGuildInvitesData structure.
Returns
A CoRoutine containing a InviteDataVector.

Definition at line 797 of file GuildEntities.cpp.

◆ getGuildPreviewAsync()

CoRoutine< GuildPreviewData > DiscordCoreAPI::Guilds::getGuildPreviewAsync ( GetGuildPreviewData  dataPackage)
static

Acquires the preview Data of a chosen Guild.

Parameters
dataPackageA GetGuildPreviewData structure.
Returns
A CoRoutine containing a GuildPreviewData.

Definition at line 644 of file GuildEntities.cpp.

◆ getGuildPruneCountAsync()

CoRoutine< GuildPruneCountData > DiscordCoreAPI::Guilds::getGuildPruneCountAsync ( GetGuildPruneCountData  dataPackage)
static

For collecting the Guild prune count.

Parameters
dataPackageA GetGuildPruneCountData structure.
Returns
A CoRoutine containing GuildPruneCountData.

Definition at line 745 of file GuildEntities.cpp.

◆ getGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::getGuildTemplateAsync ( GetGuildTemplateData  dataPackage)
static

Gets the Guild Template from a particular server.

Parameters
dataPackageA GetGuildTemplateData structure.
Returns
A CoRoutine containing a GuildTemplateData.

Definition at line 923 of file GuildEntities.cpp.

◆ getGuildTemplatesAsync()

CoRoutine< std::vector< GuildTemplateData > > DiscordCoreAPI::Guilds::getGuildTemplatesAsync ( GetGuildTemplatesData  dataPackage)
static

Collects a list of Guild Templates from a chosen Guild.

Parameters
dataPackageA GetGuildTemplatesData structure.
Returns
A CoRoutine containing a GuiildTemplateDataVector.

Definition at line 947 of file GuildEntities.cpp.

◆ getGuildVanityInviteAsync()

CoRoutine< InviteData > DiscordCoreAPI::Guilds::getGuildVanityInviteAsync ( GetGuildVanityInviteData  dataPackage)
static

Gets the vanity invite responseData from a particular server.

Parameters
dataPackageA GetGuildVanityInviteData structure.
Returns
A CoRoutine containing InviteData.

Definition at line 861 of file GuildEntities.cpp.

◆ getGuildVoiceRegionsAsync()

CoRoutine< std::vector< VoiceRegionData > > DiscordCoreAPI::Guilds::getGuildVoiceRegionsAsync ( GetGuildVoiceRegionsData  dataPackage)
static

Gets the list of voice regions for a particular server.

Parameters
dataPackageA GetGuildVoiceRegionsData structure.
Returns
A CoRoutine containing a VoiceRegionDataVector.

Definition at line 788 of file GuildEntities.cpp.

◆ getGuildWelcomeScreenAsync()

CoRoutine< WelcomeScreenData > DiscordCoreAPI::Guilds::getGuildWelcomeScreenAsync ( GetGuildWelcomeScreenData  dataPackage)
static

Gets the Guild welcome screen for a particular server.

Parameters
dataPackageA GetGuildWelcomeScreenData structure.
Returns
A CoRoutine containing a WelcomeScreenData.

Definition at line 901 of file GuildEntities.cpp.

◆ getGuildWidgetAsync()

CoRoutine< GuildWidgetData > DiscordCoreAPI::Guilds::getGuildWidgetAsync ( GetGuildWidgetData  dataPackage)
static

Gets the Guild widget for a particular server.

Parameters
dataPackageA GetGuildWidgetData structure.
Returns
A CoRoutine containing a GuildWidgetData.

Definition at line 852 of file GuildEntities.cpp.

◆ getGuildWidgetImageAsync()

CoRoutine< GuildWidgetImageData > DiscordCoreAPI::Guilds::getGuildWidgetImageAsync ( GetGuildWidgetImageData  dataPackage)
static

Gets the Guild widget image for a particular server.

Parameters
dataPackageA GetGuildWidgetImageData structure.
Returns
A CoRoutine containing a GuildWidgetImageData.

Definition at line 870 of file GuildEntities.cpp.

◆ getGuildWidgetSettingsAsync()

CoRoutine< GuildWidgetData > DiscordCoreAPI::Guilds::getGuildWidgetSettingsAsync ( GetGuildWidgetSettingsData  dataPackage)
static

Gets the Guild widget's settings for a particular server.

Parameters
dataPackageA GetGuildWidgetSettingsData structure.
Returns
A CoRoutine containing a GuildWidgetData.

Definition at line 827 of file GuildEntities.cpp.

◆ getInviteAsync()

CoRoutine< InviteData > DiscordCoreAPI::Guilds::getInviteAsync ( GetInviteData  dataPackage)
static

Gets an invite from the Discord servers.

Parameters
dataPackageA GetInviteData structure.
Returns
A CoRoutine containing an InviteData.

Definition at line 1000 of file GuildEntities.cpp.

◆ leaveGuildAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::leaveGuildAsync ( LeaveGuildData  dataPackage)
static

Removes the bot from a chosen Guild.

Parameters
dataPackageA LeaveGuildData structure.
Returns
A CoRoutine containing void.

Definition at line 1067 of file GuildEntities.cpp.

◆ modifyGuildAsync()

CoRoutine< Guild > DiscordCoreAPI::Guilds::modifyGuildAsync ( ModifyGuildData  dataPackage)
static

Modifies a chosen Guild's properties.

Parameters
dataPackageA ModifyGuildData structure.
Returns
A CoRoutine containing a Guild.

Definition at line 653 of file GuildEntities.cpp.

◆ modifyGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::modifyGuildTemplateAsync ( ModifyGuildTemplateData  dataPackage)
static

Modifies a Guild Template.

Parameters
dataPackageA ModifyGuildTemplateData structure.
Returns
A CoRoutine containing a GuiildTemplateData.

Definition at line 978 of file GuildEntities.cpp.

◆ modifyGuildWelcomeScreenAsync()

CoRoutine< WelcomeScreenData > DiscordCoreAPI::Guilds::modifyGuildWelcomeScreenAsync ( ModifyGuildWelcomeScreenData  dataPackage)
static

Modifies the Guild welcome screen.

Parameters
dataPackageA ModifyGuildWelcomeScreenData structure.
Returns
A CoRoutine containing a WelcomeScreenData.

Definition at line 910 of file GuildEntities.cpp.

◆ modifyGuildWidgetAsync()

CoRoutine< GuildWidgetData > DiscordCoreAPI::Guilds::modifyGuildWidgetAsync ( ModifyGuildWidgetData  dataPackage)
static

Modifies the Guild widget for a particular server.

Parameters
dataPackageA ModifyGuildWidgetData structure.
Returns
A CoRoutine containing a GuildWidgetData.

Definition at line 836 of file GuildEntities.cpp.

◆ removeGuildBanAsync()

CoRoutine< void > DiscordCoreAPI::Guilds::removeGuildBanAsync ( RemoveGuildBanData  dataPackage)
static

Removes a previously created ban.

Parameters
dataPackageA RemoveGuildBanData structure.
Returns
A CoRoutine containing void.

Definition at line 733 of file GuildEntities.cpp.

◆ syncGuildTemplateAsync()

CoRoutine< GuildTemplateData > DiscordCoreAPI::Guilds::syncGuildTemplateAsync ( SyncGuildTemplateData  dataPackage)
static

Syncs a Guild Template.

Parameters
dataPackageA SyncGuildTemplateData structure.
Returns
A CoRoutine containing a GuiildTemplateData.

Definition at line 969 of file GuildEntities.cpp.


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