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

#include <GuildEntities.hpp>

Static Public Member Functions
static co_routine< guild_prune_count_data >	beginGuildPruneAsync (const begin_guild_prune_data dataPackage)
	For performing a pruning of the guild_members of the guild, based on days of inactivity. More...

static co_routine< guild_data >	createGuildAsync (const create_guild_data dataPackage)
	Creates a new guild. More...

static co_routine< void >	createGuildBanAsync (const create_guild_ban_data dataPackage)
	Bans a guild_member. More...

static co_routine< guild_data >	createGuildFromGuildTemplateAsync (const create_guild_from_guild_template_data dataPackage)
	Creates a guild from the guild template. More...

static co_routine< guild_template_data >	createGuildTemplateAsync (const create_guild_template_data dataPackage)
	Creates a guild template. More...

static co_routine< void >	deleteGuildAsync (const delete_guild_data dataPackage)
	Deletes a chosen guild. More...

static co_routine< void >	deleteGuildIntegrationAsync (const delete_guild_integration_data dataPackage)
	Deletes an integration from a guild. More...

static co_routine< void >	deleteGuildTemplateAsync (const delete_guild_template_data dataPackage)
	Deletes a guild template. More...

static co_routine< void >	deleteInviteAsync (const delete_invite_data dataPackage)
	Deletes an invite from the discord servers. More...

static jsonifier::vector< guild_data >	getAllGuildsAsync ()
	Returns all of the guilds that the current bot is in. More...

static guild_cache_data	getCachedGuild (const get_guild_data dataPackage)
	Collects a guild from the library's cache. More...

static co_routine< jsonifier::vector< guild_data > >	getCurrentUserGuildsAsync (const get_current_user_guilds_data dataPackage)
	Collects a list of guilds that the bot is in. More...

static co_routine< guild_data >	getGuildAsync (const get_guild_data dataPackage)
	Collects a guild from the discord servers. More...

static co_routine< audit_log_data >	getGuildAuditLogsAsync (const get_guild_audit_logs_data dataPackage)
	Gets an audit log from the discord servers. More...

static co_routine< ban_data >	getGuildBanAsync (const get_guild_ban_data dataPackage)
	Collects a single ban from a chosen guild. More...

static co_routine< jsonifier::vector< ban_data > >	getGuildBansAsync (const get_guild_bans_data dataPackage)
	Collects a list of bans from a chosen guild. More...

static co_routine< jsonifier::vector< integration_data > >	getGuildIntegrationsAsync (const get_guild_integrations_data dataPackage)
	Gets the list of guild integrations for a particular server. More...

static co_routine< jsonifier::vector< invite_data > >	getGuildInvitesAsync (const get_guild_invites_data dataPackage)
	Gets multiple invites from the discord servers. More...

static co_routine< guild_preview_data >	getGuildPreviewAsync (const get_guild_preview_data dataPackage)
	Acquires the preview data of a chosen guild. More...

static co_routine< guild_prune_count_data >	getGuildPruneCountAsync (const get_guild_prune_count_data dataPackage)
	For collecting the guild prune count. More...

static co_routine< guild_template_data >	getGuildTemplateAsync (const get_guild_template_data dataPackage)
	Gets the guild template from a particular server. More...

static co_routine< jsonifier::vector< guild_template_data > >	getGuildTemplatesAsync (const get_guild_templates_data dataPackage)
	Collects a list of guild templates from a chosen guild. More...

static co_routine< invite_data >	getGuildVanityInviteAsync (const get_guild_vanity_invite_data dataPackage)
	Gets the vanity invite responseData from a particular server. More...

static co_routine< jsonifier::vector< voice_region_data > >	getGuildVoiceRegionsAsync (const get_guild_voice_regions_data dataPackage)
	Gets the list of voice regions for a particular server. More...

static co_routine< welcome_screen_data >	getGuildWelcomeScreenAsync (const get_guild_welcome_screen_data dataPackage)
	Gets the guild welcome screen for a particular server. More...

static co_routine< guild_widget_data >	getGuildWidgetAsync (const get_guild_widget_data dataPackage)
	Gets the guild widget for a particular server. More...

static co_routine< guild_widget_image_data >	getGuildWidgetImageAsync (const get_guild_widget_image_data dataPackage)
	Gets the guild widget image for a particular server. More...

static co_routine< guild_widget_data >	getGuildWidgetSettingsAsync (const get_guild_widget_settings_data dataPackage)
	Gets the guild widget's settings for a particular server. More...

static co_routine< invite_data >	getInviteAsync (const get_invite_data dataPackage)
	Gets an invite from the discord servers. More...

static co_routine< void >	leaveGuildAsync (const leave_guild_data dataPackage)
	Removes the bot from a chosen guild. More...

static co_routine< guild_data >	modifyGuildAsync (const modify_guild_data dataPackage)
	Modifies a chosen guild's properties. More...

static co_routine< guild_template_data >	modifyGuildTemplateAsync (const modify_guild_template_data dataPackage)
	Modifies a guild template. More...

static co_routine< welcome_screen_data >	modifyGuildWelcomeScreenAsync (const modify_guild_welcome_screen_data dataPackage)
	Modifies the guild welcome screen. More...

static co_routine< guild_widget_data >	modifyGuildWidgetAsync (const modify_guild_widget_data dataPackage)
	Modifies the guild widget for a particular server. More...

static co_routine< void >	removeGuildBanAsync (const remove_guild_ban_data dataPackage)
	Removes a previously created ban. More...

static co_routine< guild_template_data >	syncGuildTemplateAsync (const sync_guild_template_data dataPackage)
	Syncs a guild template. More...

Member Function Documentation

◆ beginGuildPruneAsync()

co_routine< guild_prune_count_data > discord_core_api::guilds::beginGuildPruneAsync ( const begin_guild_prune_data dataPackage )

static

Parameters

dataPackage a begin_guild_prune_data structure.

Returns: A co_routine containing a guild_prune_count_data.

Definition at line 546 of file GuildEntities.cpp.

◆ createGuildAsync()

co_routine< guild_data > discord_core_api::guilds::createGuildAsync ( const create_guild_data dataPackage )

static

Parameters

dataPackage a create_guild_data structure.

Returns: A co_routine containing a guild.

Definition at line 362 of file GuildEntities.cpp.

◆ createGuildBanAsync()

co_routine< void > discord_core_api::guilds::createGuildBanAsync ( const create_guild_ban_data dataPackage )

static

Parameters

dataPackage a create_guild_ban_data structure.

Returns: A co_routine containing a ban_data.

Definition at line 488 of file GuildEntities.cpp.

◆ createGuildFromGuildTemplateAsync()

co_routine< guild_data > discord_core_api::guilds::createGuildFromGuildTemplateAsync ( const create_guild_from_guild_template_data dataPackage )

static

Parameters

dataPackage a create_guild_from_guild_template_data structure.

Returns: A co_routine containing a guild.

Definition at line 726 of file GuildEntities.cpp.

◆ createGuildTemplateAsync()

co_routine< guild_template_data > discord_core_api::guilds::createGuildTemplateAsync ( const create_guild_template_data dataPackage )

static

Parameters

dataPackage a create_guild_template_data structure.

Returns: A co_routine containing a guiild_template_data.

Definition at line 749 of file GuildEntities.cpp.

◆ deleteGuildAsync()

co_routine< void > discord_core_api::guilds::deleteGuildAsync ( const delete_guild_data dataPackage )

static

Parameters

dataPackage a delete_guild_data structure.

Returns: A co_routine containing void.

Definition at line 440 of file GuildEntities.cpp.

◆ deleteGuildIntegrationAsync()

co_routine< void > discord_core_api::guilds::deleteGuildIntegrationAsync ( const delete_guild_integration_data dataPackage )

static

Parameters

dataPackage a delete_guild_integration_data structure.

Returns: A co_routine containing void.

Definition at line 595 of file GuildEntities.cpp.

◆ deleteGuildTemplateAsync()

co_routine< void > discord_core_api::guilds::deleteGuildTemplateAsync ( const delete_guild_template_data dataPackage )

static

Parameters

dataPackage a delete_guild_template_data structure.

Returns: A co_routine containing a void.

Definition at line 784 of file GuildEntities.cpp.

◆ deleteInviteAsync()

co_routine< void > discord_core_api::guilds::deleteInviteAsync ( const delete_invite_data dataPackage )

static

Parameters

dataPackage a delete_invite_data structure.

Returns: A co_routine containing void.

Definition at line 822 of file GuildEntities.cpp.

◆ getAllGuildsAsync()

jsonifier::vector< guild_data > discord_core_api::guilds::getAllGuildsAsync ( )

static

Returns: A co_routine containing a jsonifier::vector<guild_data>.

Definition at line 374 of file GuildEntities.cpp.

◆ getCachedGuild()

guild_cache_data discord_core_api::guilds::getCachedGuild ( const get_guild_data dataPackage )

static

Parameters

dataPackage a get_guild_data structure.

Returns: A co_routine containing a guild.

Definition at line 400 of file GuildEntities.cpp.

Here is the call graph for this function:

◆ getCurrentUserGuildsAsync()

co_routine< jsonifier::vector< guild_data > > discord_core_api::guilds::getCurrentUserGuildsAsync ( const get_current_user_guilds_data dataPackage )

static

Parameters

dataPackage a get_current_user_guilds_data structure.

Returns: A co_routine containing a guild_vector.

Definition at line 835 of file GuildEntities.cpp.

◆ getGuildAsync()

co_routine< guild_data > discord_core_api::guilds::getGuildAsync ( const get_guild_data dataPackage )

static

Parameters

dataPackage a get_guild_data structure.

Returns: A co_routine containing a guild.

Definition at line 382 of file GuildEntities.cpp.

Here is the caller graph for this function:

◆ getGuildAuditLogsAsync()

co_routine< audit_log_data > discord_core_api::guilds::getGuildAuditLogsAsync ( const get_guild_audit_logs_data dataPackage )

static

Parameters

dataPackage a get_guild_audit_logs_data structure.

Returns: A co_routine containing an audit_log_data.

Definition at line 324 of file GuildEntities.cpp.

◆ getGuildBanAsync()

co_routine< ban_data > discord_core_api::guilds::getGuildBanAsync ( const get_guild_ban_data dataPackage )

static

Parameters

dataPackage a get_guild_ban_data structure.

Returns: A co_routine containing a ban_data.

Definition at line 477 of file GuildEntities.cpp.

◆ getGuildBansAsync()

co_routine< jsonifier::vector< ban_data > > discord_core_api::guilds::getGuildBansAsync ( const get_guild_bans_data dataPackage )

static

Parameters

dataPackage a get_guild_bans_data structure.

Returns: A co_routine containing a ban_data_vector.

Definition at line 450 of file GuildEntities.cpp.

◆ getGuildIntegrationsAsync()

co_routine< jsonifier::vector< integration_data > > discord_core_api::guilds::getGuildIntegrationsAsync ( const get_guild_integrations_data dataPackage )

static

Parameters

dataPackage a get_guild_integrations_data structure.

Returns: A co_routine containing a jsonifier::vector<integration_data>.

Definition at line 584 of file GuildEntities.cpp.

◆ getGuildInvitesAsync()

co_routine< jsonifier::vector< invite_data > > discord_core_api::guilds::getGuildInvitesAsync ( const get_guild_invites_data dataPackage )

static

Parameters

dataPackage a get_guild_invites_data structure.

Returns: A co_routine containing a jsonifier::vector<invite_data>.

Definition at line 572 of file GuildEntities.cpp.

◆ getGuildPreviewAsync()

co_routine< guild_preview_data > discord_core_api::guilds::getGuildPreviewAsync ( const get_guild_preview_data dataPackage )

static

Parameters

dataPackage a get_guild_preview_data structure.

Returns: A co_routine containing a guild_preview_data.

Definition at line 408 of file GuildEntities.cpp.

◆ getGuildPruneCountAsync()

co_routine< guild_prune_count_data > discord_core_api::guilds::getGuildPruneCountAsync ( const get_guild_prune_count_data dataPackage )

static

Parameters

dataPackage a get_guild_prune_count_data structure.

Returns: A co_routine containing guild_prune_count_data.

Definition at line 515 of file GuildEntities.cpp.

◆ getGuildTemplateAsync()

co_routine< guild_template_data > discord_core_api::guilds::getGuildTemplateAsync ( const get_guild_template_data dataPackage )

static

Parameters

dataPackage a get_guild_template_data structure.

Returns: A co_routine containing a guild_template_data.

Definition at line 715 of file GuildEntities.cpp.

◆ getGuildTemplatesAsync()

co_routine< jsonifier::vector< guild_template_data > > discord_core_api::guilds::getGuildTemplatesAsync ( const get_guild_templates_data dataPackage )

static

Parameters

dataPackage a get_guild_templates_data structure.

Returns: A co_routine containing a guiild_template_data_vector.

Definition at line 738 of file GuildEntities.cpp.

◆ getGuildVanityInviteAsync()

co_routine< invite_data > discord_core_api::guilds::getGuildVanityInviteAsync ( const get_guild_vanity_invite_data dataPackage )

static

Parameters

dataPackage a get_guild_vanity_invite_data structure.

Returns: A co_routine containing invite_data.

Definition at line 645 of file GuildEntities.cpp.

◆ getGuildVoiceRegionsAsync()

co_routine< jsonifier::vector< voice_region_data > > discord_core_api::guilds::getGuildVoiceRegionsAsync ( const get_guild_voice_regions_data dataPackage )

static

Parameters

dataPackage a get_guild_voice_regions_data structure.

Returns: A co_routine containing a voice_region_data_vector.

Definition at line 561 of file GuildEntities.cpp.

◆ getGuildWelcomeScreenAsync()

co_routine< welcome_screen_data > discord_core_api::guilds::getGuildWelcomeScreenAsync ( const get_guild_welcome_screen_data dataPackage )

static

Parameters

dataPackage a get_guild_welcome_screen_data structure.

Returns: A co_routine containing a welcome_screen_data.

Definition at line 689 of file GuildEntities.cpp.

◆ getGuildWidgetAsync()

co_routine< guild_widget_data > discord_core_api::guilds::getGuildWidgetAsync ( const get_guild_widget_data dataPackage )

static

Parameters

dataPackage a get_guild_widget_data structure.

Returns: A co_routine containing a guild_widget_data.

Definition at line 634 of file GuildEntities.cpp.

◆ getGuildWidgetImageAsync()

co_routine< guild_widget_image_data > discord_core_api::guilds::getGuildWidgetImageAsync ( const get_guild_widget_image_data dataPackage )

static

Parameters

dataPackage a get_guild_widget_image_data structure.

Returns: A co_routine containing a guild_widget_image_data.

Definition at line 656 of file GuildEntities.cpp.

◆ getGuildWidgetSettingsAsync()

co_routine< guild_widget_data > discord_core_api::guilds::getGuildWidgetSettingsAsync ( const get_guild_widget_settings_data dataPackage )

static

Parameters

dataPackage a get_guild_widget_settings_data structure.

Returns: A co_routine containing a guild_widget_data.

Definition at line 608 of file GuildEntities.cpp.

◆ getInviteAsync()

co_routine< invite_data > discord_core_api::guilds::getInviteAsync ( const get_invite_data dataPackage )

static

Parameters

dataPackage a get_invite_data structure.

Returns: A co_routine containing an invite_data.

Definition at line 794 of file GuildEntities.cpp.

◆ leaveGuildAsync()

co_routine< void > discord_core_api::guilds::leaveGuildAsync ( const leave_guild_data dataPackage )

static

Parameters

dataPackage a leave_guild_data structure.

Returns: A co_routine containing void.

Definition at line 862 of file GuildEntities.cpp.

◆ modifyGuildAsync()

co_routine< guild_data > discord_core_api::guilds::modifyGuildAsync ( const modify_guild_data dataPackage )

static

Parameters

dataPackage a modify_guild_data structure.

Returns: A co_routine containing a guild.

Definition at line 419 of file GuildEntities.cpp.

◆ modifyGuildTemplateAsync()

co_routine< guild_template_data > discord_core_api::guilds::modifyGuildTemplateAsync ( const modify_guild_template_data dataPackage )

static

Parameters

dataPackage a modify_guild_template_data structure.

Returns: A co_routine containing a guiild_template_data.

Definition at line 772 of file GuildEntities.cpp.

◆ modifyGuildWelcomeScreenAsync()

co_routine< welcome_screen_data > discord_core_api::guilds::modifyGuildWelcomeScreenAsync ( const modify_guild_welcome_screen_data dataPackage )

static

Parameters

dataPackage a modify_guild_welcome_screen_data structure.

Returns: A co_routine containing a welcome_screen_data.

Definition at line 700 of file GuildEntities.cpp.

◆ modifyGuildWidgetAsync()

co_routine< guild_widget_data > discord_core_api::guilds::modifyGuildWidgetAsync ( const modify_guild_widget_data dataPackage )

static

Parameters

dataPackage a modify_guild_widget_data structure.

Returns: A co_routine containing a guild_widget_data.

Definition at line 619 of file GuildEntities.cpp.

◆ removeGuildBanAsync()

co_routine< void > discord_core_api::guilds::removeGuildBanAsync ( const remove_guild_ban_data dataPackage )

static

Parameters

dataPackage a remove_guild_ban_data structure.

Returns: A co_routine containing void.

Definition at line 502 of file GuildEntities.cpp.

◆ syncGuildTemplateAsync()

co_routine< guild_template_data > discord_core_api::guilds::syncGuildTemplateAsync ( const sync_guild_template_data dataPackage )

static

Parameters

dataPackage a sync_guild_template_data structure.

Returns: A co_routine containing a guiild_template_data.

Definition at line 761 of file GuildEntities.cpp.

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

Static Public Member Functions

Member Function Documentation

◆ beginGuildPruneAsync()

◆ createGuildAsync()

◆ createGuildBanAsync()

◆ createGuildFromGuildTemplateAsync()

◆ createGuildTemplateAsync()

◆ deleteGuildAsync()

◆ deleteGuildIntegrationAsync()

◆ deleteGuildTemplateAsync()

◆ deleteInviteAsync()

◆ getAllGuildsAsync()

◆ getCachedGuild()

◆ getCurrentUserGuildsAsync()

◆ getGuildAsync()

◆ getGuildAuditLogsAsync()

◆ getGuildBanAsync()

◆ getGuildBansAsync()

◆ getGuildIntegrationsAsync()

◆ getGuildInvitesAsync()

◆ getGuildPreviewAsync()

◆ getGuildPruneCountAsync()

◆ getGuildTemplateAsync()

◆ getGuildTemplatesAsync()

◆ getGuildVanityInviteAsync()

◆ getGuildVoiceRegionsAsync()

◆ getGuildWelcomeScreenAsync()

◆ getGuildWidgetAsync()

◆ getGuildWidgetImageAsync()

◆ getGuildWidgetSettingsAsync()

◆ getInviteAsync()

◆ leaveGuildAsync()

◆ modifyGuildAsync()

◆ modifyGuildTemplateAsync()

◆ modifyGuildWelcomeScreenAsync()

◆ modifyGuildWidgetAsync()

◆ removeGuildBanAsync()

◆ syncGuildTemplateAsync()