dpp::guild_member Class Reference

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>

Collaboration diagram for dpp::guild_member:

Public Member Functions
	guild_member ()
guild_member &	fill_from_json (nlohmann::json *j, snowflake g_id, snowflake u_id)
std::string	build_json () const
	Build json string for the member object. More...
bool	is_deaf () const
	Returns true if the user is deafened. More...
bool	is_muted () const
	Returns true if the user is muted. More...
bool	is_pending () const
	Returns true if pending verification by membership screening. More...
bool	has_animated_guild_avatar () const
	Returns true if the user's per-guild custom avatar is animated. More...
std::string	get_avatar_url () const
	Returns the members's per guild avatar if they have one, otherwise returns an empty string. More...
guild_member &	set_nickname (const std::string &nick)
	Set the nickname. More...
guild_member &	set_mute (const bool is_muted)
	Set whether the user is muted in voice channels. More...
guild_member &	set_deaf (const bool is_deafened)
	Set whether the user is deafened in voice channels. More...
guild_member &	set_communication_disabled_until (const time_t timestamp)
	Set communication_disabled_until. More...

Public Attributes
std::string	nickname
snowflake	guild_id
snowflake	user_id
std::vector< snowflake >	roles
time_t	joined_at
time_t	premium_since
uint8_t	flags
utility::iconhash	avatar
time_t	communication_disabled_until

Detailed Description

Represents dpp::user membership upon a dpp::guild. This contains the user's nickname, guild roles, and any other guild-specific flags.

Constructor & Destructor Documentation

guild_member()

dpp::guild_member::guild_member

(

)

Default constructor

Member Function Documentation

build_json()

std::string dpp::guild_member::build_json

(

)

const

Build json string for the member object.

Returns

std::string json string

fill_from_json()

guild_member & dpp::guild_member::fill_from_json	(	nlohmann::json *	j,
		snowflake	g_id,
		snowflake	u_id
	)

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

(

)

const

Returns the members's per guild avatar if they have one, otherwise returns an empty string.

Returns

std::string avatar or empty string

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

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

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

nick	Nickname to set

Returns

guild_member& reference to self

Member Data Documentation

avatar

utility::iconhash dpp::guild_member::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

uint8_t dpp::guild_member::flags

A set of flags built from the bitmask defined by dpp::guild_member_flags

guild_id

snowflake dpp::guild_member::guild_id

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

Boosting since

roles

std::vector<snowflake> dpp::guild_member::roles

List of roles this user has on this guild

user_id

snowflake dpp::guild_member::user_id

User id