Represents dpp::user membership upon a dpp::guild. This contains the user's nickname, guild roles, and any other guild-specific flags.
More...
#include <guild.h>
Represents dpp::user membership upon a dpp::guild. This contains the user's nickname, guild roles, and any other guild-specific flags.
◆ guild_member()
| dpp::guild_member::guild_member |
( |
| ) |
|
◆ build_json()
| std::string dpp::guild_member::build_json |
( |
bool |
with_id = false | ) |
const |
Build json string for the member object.
- Parameters
-
- Returns
- std::string json string
◆ fill_from_json()
Fill this object from a json object.
- Parameters
-
| j | The json object to get data from |
| g_id | The guild id to associate the member with |
| u_id | The user id to associate the member with |
- Returns
- Reference to self for call chaining
◆ get_avatar_url()
| std::string dpp::guild_member::get_avatar_url |
( |
uint16_t |
size = 0, |
|
|
const image_type |
format = i_png, |
|
|
bool |
prefer_animated = true |
|
) |
| const |
Returns the member's per guild avatar url if they have one, otherwise returns an empty string.
- Note
- per-server avatar is a nitro only feature so it might be not set. If you need the user avatar, use user::get_avatar_url.
- Parameters
-
| size | The size of the avatar in pixels. It can be any power of two between 16 and 4096, otherwise the default sized avatar is returned. |
| format | The format to use for the avatar. It can be one of i_webp, i_jpg, i_png or i_gif. When passing i_gif, it returns an empty string for non-animated images. Consider using the prefer_animated parameter instead. |
| prefer_animated | Whether you prefer gif format. If true, it'll return gif format whenever the image is available as animated. |
- Returns
- std::string avatar url or an empty string, if required attributes are missing or an invalid format was passed
◆ get_mention()
| std::string dpp::guild_member::get_mention |
( |
| ) |
const |
Return a ping/mention for the user by nickname.
- Returns
- std::string mention
◆ get_user()
| user * dpp::guild_member::get_user |
( |
| ) |
const |
Find the dpp::user object for this member. This is an alias for dpp::find_user.
- Returns
- dpp::user* Pointer to the user object. If not in cache, it returns nullptr
◆ has_animated_guild_avatar()
| bool dpp::guild_member::has_animated_guild_avatar |
( |
| ) |
const |
Returns true if the user's per-guild custom avatar is animated.
- Returns
- true user's custom avatar is animated
-
false user's custom avatar is not animated
◆ has_bypasses_verification()
| bool dpp::guild_member::has_bypasses_verification |
( |
| ) |
const |
Returns true if the user is exempt from guild verification requirements.
- Returns
- true user bypasses verification
-
false user doesn't bypass verification
◆ has_completed_onboarding()
| bool dpp::guild_member::has_completed_onboarding |
( |
| ) |
const |
Returns true if the user has completed onboarding.
- Returns
- true user has completed onboarding
-
false user has not completed onboarding
◆ has_rejoined()
| bool dpp::guild_member::has_rejoined |
( |
| ) |
const |
Returns true if the user has left and rejoined the guild.
- Returns
- true user has left and rejoined the guild
-
false user has not rejoined
◆ has_started_onboarding()
| bool dpp::guild_member::has_started_onboarding |
( |
| ) |
const |
Returns true if the user has started onboarding.
- Returns
- true user has started onboarding
-
false user has not started onboarding yet
◆ is_communication_disabled()
| bool dpp::guild_member::is_communication_disabled |
( |
| ) |
const |
Returns true if the user is in time-out (communication disabled)
- Returns
- true user is in time-out
-
false user is not in time-out
◆ is_deaf()
| bool dpp::guild_member::is_deaf |
( |
| ) |
const |
Returns true if the user is deafened.
- Returns
- true user is deafened
-
false user is not deafened
◆ is_muted()
| bool dpp::guild_member::is_muted |
( |
| ) |
const |
Returns true if the user is muted.
- Returns
- true user muted
-
false user not muted
◆ is_pending()
| bool dpp::guild_member::is_pending |
( |
| ) |
const |
Returns true if pending verification by membership screening.
- Returns
- true user has completed membership screening
-
false user has not completed membership screening
◆ operator==()
| bool dpp::guild_member::operator== |
( |
guild_member const & |
other_member | ) |
const |
Check if this member is equal to another member object.
- Parameters
-
| other_member | other member object to compare |
- Returns
- true if their user ids are equal, false otherwise.
◆ set_bypasses_verification()
| guild_member & dpp::guild_member::set_bypasses_verification |
( |
const bool |
is_bypassing_verification | ) |
|
Set whether the user is exempt from guild verification requirements.
- Parameters
-
| is_bypassing_verification | value to set |
- Returns
- guild_member& reference to self
◆ set_communication_disabled_until()
| guild_member & dpp::guild_member::set_communication_disabled_until |
( |
const time_t |
timestamp | ) |
|
Set communication_disabled_until.
- Parameters
-
| timestamp | timestamp until communication is disabled |
- Returns
- guild_member& reference to self
◆ set_deaf()
| guild_member & dpp::guild_member::set_deaf |
( |
const bool |
is_deafened | ) |
|
Set whether the user is deafened in voice channels.
- Parameters
-
| is_deafened | value to set, true if deaf in voice channels |
- Returns
- guild_member& reference to self
◆ set_mute()
| guild_member & dpp::guild_member::set_mute |
( |
const bool |
is_muted | ) |
|
Set whether the user is muted in voice channels.
- Parameters
-
| is_muted | value to set, true if mute in voice channels |
- Returns
- guild_member& reference to self
◆ set_nickname()
| guild_member & dpp::guild_member::set_nickname |
( |
const std::string & |
nick | ) |
|
Set the nickname.
- Parameters
-
- Returns
- guild_member& reference to self
◆ avatar
User avatar (per-server avatar is a nitro only feature)
◆ communication_disabled_until
| time_t dpp::guild_member::communication_disabled_until |
timestamp of when the time out will be removed; until then, they cannot interact with the guild
◆ flags
| uint16_t dpp::guild_member::flags |
◆ guild_id
◆ joined_at
| time_t dpp::guild_member::joined_at |
Date and time the user joined the guild
◆ nickname
| std::string dpp::guild_member::nickname |
Nickname, or empty string if they don't have a nickname on this guild
◆ premium_since
| time_t dpp::guild_member::premium_since |
◆ roles
| std::vector<snowflake> dpp::guild_member::roles |
List of roles this user has on this guild
◆ user_id
Collaboration diagram for dpp::guild_member: