dpp::guild_member Class Reference

Represents dpp::user membership upon a dpp::guild. 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
bool	is_deaf () const
bool	is_muted () const
bool	is_pending () const
bool	has_animated_guild_avatar () const
std::string	get_avatar_url () const

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

Detailed Description

Represents dpp::user membership upon a dpp::guild.

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

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

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

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

is_deaf()

bool dpp::guild_member::is_deaf

(

)

const

Returns true if the user is deafened

is_muted()

bool dpp::guild_member::is_muted

(

)

const

Returns true if the user is muted

is_pending()

bool dpp::guild_member::is_pending

(

)

const

Returns true if pending verification by membership screening

Member Data Documentation

avatar

utility::iconhash dpp::guild_member::avatar

User avatar (per-server avatar is a nitro only feature)

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 nullptr 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