|
Discord Social SDK
|
Represents a guild (also known as a Discord server) that the current user is a member of, along with the current user's permissions in it.
Public Member Functions | |
| UserGuild (UserGuild &&other) noexcept | |
| Move constructor for UserGuild. | |
| UserGuild & | operator= (UserGuild &&other) noexcept |
| Move assignment operator for UserGuild. | |
| operator bool () const | |
| Returns true if the instance contains a valid object. | |
| UserGuild (const UserGuild &arg0) | |
| Copy constructor for UserGuild. | |
| UserGuild & | operator= (const UserGuild &arg0) |
| Copy assignment operator for UserGuild. | |
| uint64_t | Id () const |
| The id of the guild. | |
| void | SetId (uint64_t Id) |
| Setter for UserGuild::Id. | |
| discordpp::String | Name () const |
| The name of the guild. | |
| void | SetName (std::string_view Name) |
| Setter for UserGuild::Name. | |
| std::optional< discordpp::String > | Icon () const |
| The hash of the guild's icon, if it has one. | |
| void | SetIcon (std::optional< std::string_view > Icon) |
| Setter for UserGuild::Icon. | |
| std::optional< discordpp::String > | Banner () const |
| The hash of the guild's banner, if it has one. | |
| void | SetBanner (std::optional< std::string_view > Banner) |
| Setter for UserGuild::Banner. | |
| bool | Owner () const |
| Whether the current user is the owner of the guild. | |
| void | SetOwner (bool Owner) |
| Setter for UserGuild::Owner. | |
| uint64_t | Permissions () const |
| The current user's permissions in the guild, as a bitfield of Discord permission flags. | |
| void | SetPermissions (uint64_t Permissions) |
| Setter for UserGuild::Permissions. | |
| std::optional< discordpp::LinkedGameOrganization > | LinkedGameOrganization () const |
| Information about the game organization linked to this guild, if any. | |
| void | SetLinkedGameOrganization (std::optional< discordpp::LinkedGameOrganization > LinkedGameOrganization) |
| Setter for UserGuild::LinkedGameOrganization. | |
Static Public Attributes | |
| static const UserGuild | nullobj |
| Uninitialized instance of UserGuild. | |
| std::optional< discordpp::String > discordpp::UserGuild::Banner | ( | ) | const |
The hash of the guild's banner, if it has one.
| std::optional< discordpp::String > discordpp::UserGuild::Icon | ( | ) | const |
The hash of the guild's icon, if it has one.
| uint64_t discordpp::UserGuild::Id | ( | ) | const |
The id of the guild.
| std::optional< discordpp::LinkedGameOrganization > discordpp::UserGuild::LinkedGameOrganization | ( | ) | const |
Information about the game organization linked to this guild, if any.
| discordpp::String discordpp::UserGuild::Name | ( | ) | const |
The name of the guild.
|
inline |
Returns true if the instance contains a valid object.
Copy assignment operator for UserGuild.
Move assignment operator for UserGuild.
| bool discordpp::UserGuild::Owner | ( | ) | const |
Whether the current user is the owner of the guild.
| uint64_t discordpp::UserGuild::Permissions | ( | ) | const |
The current user's permissions in the guild, as a bitfield of Discord permission flags.
Guild owners have all permissions.
| void discordpp::UserGuild::SetBanner | ( | std::optional< std::string_view > | Banner | ) |
Setter for UserGuild::Banner.
| void discordpp::UserGuild::SetIcon | ( | std::optional< std::string_view > | Icon | ) |
Setter for UserGuild::Icon.
| void discordpp::UserGuild::SetId | ( | uint64_t | Id | ) |
Setter for UserGuild::Id.
| void discordpp::UserGuild::SetLinkedGameOrganization | ( | std::optional< discordpp::LinkedGameOrganization > | LinkedGameOrganization | ) |
Setter for UserGuild::LinkedGameOrganization.
| void discordpp::UserGuild::SetName | ( | std::string_view | Name | ) |
Setter for UserGuild::Name.
| void discordpp::UserGuild::SetOwner | ( | bool | Owner | ) |
Setter for UserGuild::Owner.
| void discordpp::UserGuild::SetPermissions | ( | uint64_t | Permissions | ) |
Setter for UserGuild::Permissions.