Represents a user on discord. May or may not be a member of a dpp::guild. More...

#include <user.h>

Inheritance diagram for dpp::user:

Collaboration diagram for dpp::user:

Public Member Functions
	user ()
	Construct a new user object. More...

virtual	~user ()
	Destroy the user object. More...

user &	fill_from_json (nlohmann::json *j)

std::string	get_avatar_url (uint32_t size=0) const
	Get the avatar url of the user object. More...

std::string	get_mention () const
	Return a ping/mention for the user. More...

bool	is_bot () const
	User is a bot. More...

bool	is_system () const
	User is a system user (Clyde) More...

bool	is_mfa_enabled () const
	User has multi-factor authentication enabled. More...

bool	is_verified () const
	Return true if user has verified account. More...

bool	has_nitro_full () const
	Return true if user has full nitro. This is mutually exclusive with full nitro. More...

bool	has_nitro_classic () const
	Return true if user has nitro classic. This is mutually exclusive with nitro classic. More...

bool	is_discord_employee () const
	Return true if user is a discord employee. More...

bool	is_partnered_owner () const
	Return true if user owns a partnered server. More...

bool	has_hypesquad_events () const
	Return true if user has hypesquad events. More...

bool	is_bughunter_1 () const
	Return true if user has the bughunter level 1 badge. More...

bool	is_house_bravery () const
	Return true if user is in house bravery. More...

bool	is_house_brilliance () const
	Return true if user is in house brilliance. More...

bool	is_house_balanace () const
	Return true if user is in house balance. More...

bool	is_early_supporter () const
	Return true if user is an early supporter. More...

bool	is_team_user () const
	Return true if user is a team user. More...

bool	is_bughunter_2 () const
	Return true if user has the bughunter level 2 badge. More...

bool	is_verified_bot () const
	Return true if user has the verified bot badge. More...

bool	is_verified_bot_dev () const
	Return true if user is an early verified bot developer. More...

bool	is_certified_moderator () const
	Return true if user is a certified moderator. More...

bool	is_bot_http_interactions () const
	Return true if user is a bot which exclusively uses HTTP interactions. Bots using HTTP interactions are always considered online even when not connected to a websocket. More...

bool	has_animated_icon () const
	Return true if user has an animated icon. More...

double	get_creation_time () const
	Get the creation time of this object according to Discord. More...

Public Attributes
std::string	username

uint16_t	discriminator

utility::iconhash	avatar

uint32_t	flags

uint8_t	refcount

snowflake	id
	Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relavent to us as useful metadata. More...

Detailed Description

Represents a user on discord. May or may not be a member of a dpp::guild.

Constructor & Destructor Documentation

◆ user()

dpp::user::user ( )

Construct a new user object.

◆ ~user()

virtual dpp::user::~user ( )

virtual

Destroy the user object.

Member Function Documentation

◆ fill_from_json()

user & dpp::user::fill_from_json ( nlohmann::json * j )

Fill this record from json.

Parameters

j	The json to fill this record from

Returns: Reference to self

◆ get_avatar_url()

std::string dpp::user::get_avatar_url ( uint32_t size = 0 ) const

Get the avatar url of the user object.

Parameters

size	The size of the avatar in pixels, if not specified, the default size is returned.

Returns: std::string avatar url

◆ get_creation_time()

double dpp::managed::get_creation_time ( ) const

inherited

Get the creation time of this object according to Discord.

Returns: double creation time inferred from the snowflake ID. The minimum possible value is the first second of 2015.

◆ get_mention()

std::string dpp::user::get_mention ( ) const

Return a ping/mention for the user.

Returns: std::string mention

◆ has_animated_icon()

bool dpp::user::has_animated_icon ( ) const

Return true if user has an animated icon.

Returns: true if icon is animated (gif)

◆ has_hypesquad_events()

bool dpp::user::has_hypesquad_events ( ) const

Return true if user has hypesquad events.

Returns: true if has hypesquad events

◆ has_nitro_classic()

bool dpp::user::has_nitro_classic ( ) const

Return true if user has nitro classic. This is mutually exclusive with nitro classic.

Returns: true if user has nitro classic

◆ has_nitro_full()

bool dpp::user::has_nitro_full ( ) const

Return true if user has full nitro. This is mutually exclusive with full nitro.

Returns: true if user has full nitro

◆ is_bot()

bool dpp::user::is_bot ( ) const

User is a bot.

Returns: True if the user is a bot

◆ is_bot_http_interactions()

bool dpp::user::is_bot_http_interactions ( ) const

Return true if user is a bot which exclusively uses HTTP interactions. Bots using HTTP interactions are always considered online even when not connected to a websocket.

Returns: true if is a http interactions only bot

◆ is_bughunter_1()

bool dpp::user::is_bughunter_1 ( ) const

Return true if user has the bughunter level 1 badge.

Returns: true if has bughunter level 1

◆ is_bughunter_2()

bool dpp::user::is_bughunter_2 ( ) const

Return true if user has the bughunter level 2 badge.

Returns: true if has bughunter level 2

◆ is_certified_moderator()

bool dpp::user::is_certified_moderator ( ) const

Return true if user is a certified moderator.

Returns: true if certified moderator

◆ is_discord_employee()

bool dpp::user::is_discord_employee ( ) const

Return true if user is a discord employee.

Returns: true if user is discord staff

◆ is_early_supporter()

bool dpp::user::is_early_supporter ( ) const

Return true if user is an early supporter.

Returns: true if early supporter

◆ is_house_balanace()

bool dpp::user::is_house_balanace ( ) const

Return true if user is in house balance.

Returns: true if in house brilliance

◆ is_house_bravery()

bool dpp::user::is_house_bravery ( ) const

Return true if user is in house bravery.

Returns: true if in house bravery

◆ is_house_brilliance()

bool dpp::user::is_house_brilliance ( ) const

Return true if user is in house brilliance.

Returns: true if in house brilliance

◆ is_mfa_enabled()

bool dpp::user::is_mfa_enabled ( ) const

User has multi-factor authentication enabled.

Returns: true if multi-factor is enabled

◆ is_partnered_owner()

bool dpp::user::is_partnered_owner ( ) const

Return true if user owns a partnered server.

Returns: true if user has partnered server

◆ is_system()

bool dpp::user::is_system ( ) const

User is a system user (Clyde)

Returns: true if user is a system user

◆ is_team_user()

bool dpp::user::is_team_user ( ) const

Return true if user is a team user.

Returns: true if a team user

◆ is_verified()

bool dpp::user::is_verified ( ) const

Return true if user has verified account.

Returns: true if verified

◆ is_verified_bot()

bool dpp::user::is_verified_bot ( ) const

Return true if user has the verified bot badge.

Returns: true if verified bot

◆ is_verified_bot_dev()

bool dpp::user::is_verified_bot_dev ( ) const

Return true if user is an early verified bot developer.

Returns: true if verified bot developer

Member Data Documentation

◆ avatar

utility::iconhash dpp::user::avatar

Avatar hash

◆ discriminator

uint16_t dpp::user::discriminator

Discriminator (aka tag), 4 digits usually displayed with leading zeroes

◆ flags

uint32_t dpp::user::flags

Flags built from a bitmask of values in dpp::user_flags

◆ id

snowflake dpp::managed::id