Represents a user on discord. More...

#include "user.h"

Inheritance diagram for dpp::user:

[legend]

Collaboration diagram for dpp::user:

[legend]

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

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

std::string	build_json (bool with_id=false) const
	Convert object to json string. More...

user &	fill_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...

std::string	format_username () const
	Format a username into user#discriminator. More...

std::string	get_avatar_decoration_url (uint16_t size=0) const
	Get the avatar decoration url of the user if they have one, otherwise returns an empty string. More...

std::string	get_avatar_url (uint16_t size=0, const image_type format=i_png, bool prefer_animated=true) const
	Get the avatar url of the user. More...

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

std::string	get_default_avatar_url () const
	Get the default avatar url of the user. More...

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

std::string	get_url () const
	Returns URL to user. More...

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

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

bool	has_nitro_basic () const
	Return true if user has nitro basic. More...

bool	has_nitro_classic () const
	Return true if user has nitro classic. More...

bool	has_nitro_full () const
	Return true if user has full nitro. More...

bool	is_active_developer () const
	Return true if user has the active Developer badge. More...

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

bool	is_bot_http_interactions () const
	Return true if user is a bot which exclusively uses HTTP interactions. More...

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

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

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

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

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

bool	is_house_balance () const
	Return true if user is in house balance. 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_mfa_enabled () const
	User has multi-factor authentication enabled. More...

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

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

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

bool	is_verified () const
	Return true if user has verified account. 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...

constexpr bool	operator!= (const managed &other) const noexcept
	Comparison operator for comparing two managed objects by id. More...

constexpr bool	operator== (const managed &other) const noexcept
	Comparison operator for comparing two managed objects by id. More...

auto	to_json (bool with_id=false) const
	Convert object to nlohmann::json. More...

Static Public Member Functions
static std::string	get_mention (const snowflake &id)
	Create a mentionable user. More...

Public Attributes
utility::iconhash	avatar
	Avatar hash. More...

utility::iconhash	avatar_decoration
	Avatar decoration hash. More...

uint16_t	discriminator
	Discriminator (aka tag), 4 digits usually displayed with leading zeroes. More...

uint32_t	flags
	Flags built from a bitmask of values in dpp::user_flags. More...

std::string	global_name
	Global display name. More...

snowflake	id = {}
	Unique ID of object set by Discord. More...

uint8_t	refcount
	Reference count of how many guilds this user is in. More...

std::string	username
	Discord username. More...

Protected Member Functions
user &	fill_from_json_impl (nlohmann::json *j)
	Fill this record from json. More...

virtual json	to_json_impl (bool with_id=true) const
	Convert to JSON. More...

Friends
struct	json_interface< user >

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 ( )

virtualdefault

Destroy the user object.

Member Function Documentation

◆ build_json()

std::string dpp::json_interface< user >::build_json ( bool with_id = false ) const

inlineinherited

Convert object to json string.

Parameters

with_id Whether to include the ID or not

Note: Some fields are conditionally filled, do not rely on all fields being present

Returns: std::string Json built from the structure

◆ fill_from_json()

user & dpp::json_interface< user >::fill_from_json ( nlohmann::json * j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns: T& Reference to self for fluent calling

◆ fill_from_json_impl()

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

protected

Fill this record from json.

Parameters

j	The json to fill this record from

Returns: Reference to self

◆ format_username()

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

Format a username into user#discriminator.

For example Brain#0001

Note: This will, most often, return something like Brain#0000 due to discriminators slowly being removed. Some accounts, along with most bots, still have discriminators, so they will still show as Bot#1234.

Returns: Formatted username and discriminator

References flags, and dpp::u_bot.

◆ get_avatar_decoration_url()

std::string dpp::user::get_avatar_decoration_url ( uint16_t size = 0 ) const

Get the avatar decoration url of the user if they have one, otherwise returns an empty string.

Parameters

size	The size of the avatar decoration in pixels. It can be any power of two between 16 and 4096, otherwise the default sized avatar decoration is returned.

Returns: std::string avatar url or an empty string

◆ get_avatar_url()

std::string dpp::user::get_avatar_url	(	uint16_t	size = `0`,
		const image_type	format = `i_png`,
		bool	prefer_animated = `true`
	)		const

Get the avatar url of the user.

Note: If the user doesn't have an avatar, the default user avatar url is returned which is always in png format!

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_creation_time()

constexpr double dpp::managed::get_creation_time ( ) const

inlineconstexprnoexceptinherited

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_default_avatar_url()

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

Get the default avatar url of the user.

This is calculated by the discriminator.

Returns: std::string avatar url or an empty string, if the discriminator is empty

◆ get_mention() [1/2]

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

Return a ping/mention for the user.

Returns: std::string mention

References flags, and dpp::u_mfa_enabled.

◆ get_mention() [2/2]

std::string dpp::user::get_mention ( const snowflake & id )

static

Create a mentionable user.

Parameters

id	The ID of the user.

Returns: std::string The formatted mention of the user.

◆ get_url()

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

Returns URL to user.

Returns: string of URL to user

References flags, and dpp::u_verified.

◆ 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)

References dpp::user_identified::banner, dpp::utility::cdn_endpoint_url_hash(), dpp::user_identified::has_animated_banner(), dpp::i_gif, dpp::i_jpg, dpp::i_png, dpp::i_webp, and dpp::utility::iconhash::to_string().

Here is the call graph for this function:

◆ has_hypesquad_events()

bool dpp::user::has_hypesquad_events ( ) const

Return true if user has hypesquad events.

Returns: true if has hypesquad events

References flags, and dpp::u_early_supporter.

◆ has_nitro_basic()

bool dpp::user::has_nitro_basic ( ) const

Return true if user has nitro basic.

This is mutually exclusive with nitro basic.

Returns: true if user has nitro basic

References flags, and dpp::u_house_bravery.

◆ 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

References flags, and dpp::u_bughunter_1.

◆ 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

References flags, and dpp::u_hypesquad_events.

◆ is_active_developer()

bool dpp::user::is_active_developer ( ) const

Return true if user has the active Developer badge.

Returns: true if has active developer

References flags, and dpp::u_nitro_full.

◆ is_bot()

bool dpp::user::is_bot ( ) const

User is a bot.

Returns: True if the user is a bot

References flags, and dpp::u_nitro_classic.

◆ 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

References flags, and dpp::u_team_user.

◆ 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

References flags, and dpp::u_animated_icon.

◆ 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

References flags, and dpp::u_house_brilliance.

◆ is_early_supporter()

bool dpp::user::is_early_supporter ( ) const

Return true if user is an early supporter.

Returns: true if early supporter

References flags, and dpp::u_certified_moderator.

◆ is_house_balance()

bool dpp::user::is_house_balance ( ) const

Return true if user is in house balance.

Returns: true if in house brilliance

References flags, and dpp::u_verified_bot_dev.

◆ is_house_bravery()

bool dpp::user::is_house_bravery ( ) const

Return true if user is in house bravery.

Returns: true if in house bravery

References flags, and dpp::u_bughunter_2.

◆ is_house_brilliance()

bool dpp::user::is_house_brilliance ( ) const

Return true if user is in house brilliance.

Returns: true if in house brilliance

References flags, and dpp::u_verified_bot.

◆ is_mfa_enabled()

bool dpp::user::is_mfa_enabled ( ) const

User has multi-factor authentication enabled.

Returns: true if multi-factor is enabled

References flags, and dpp::u_discord_employee.

◆ 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

References flags, and dpp::u_house_balance.

◆ is_system()

bool dpp::user::is_system ( ) const

User is a system user (Clyde)

Returns: true if user is a system user

References flags, and dpp::u_nitro_basic.

◆ is_team_user()

bool dpp::user::is_team_user ( ) const

Return true if user is a team user.

Returns: true if a team user

References flags, and dpp::u_bot_http_interactions.

◆ is_verified()

bool dpp::user::is_verified ( ) const

Return true if user has verified account.

Returns: true if verified

References flags, and dpp::u_partnered_owner.

◆ 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

◆ operator!=()

constexpr bool dpp::managed::operator!= ( const managed & other ) const

inlineconstexprnoexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters

other Other object to compare against

Returns: true objects are not the same id; false objects are the same id

◆ operator==()

constexpr bool dpp::managed::operator== ( const managed & other ) const

inlineconstexprnoexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters

other Other object to compare against

Returns: true objects are the same id; false objects are not the same id

◆ to_json()

auto dpp::json_interface< user >::to_json ( bool with_id = false ) const

inlineinherited

Convert object to nlohmann::json.

Parameters

with_id Whether to include the ID or not

Note: Some fields are conditionally filled, do not rely on all fields being present

Returns: json Json built from the structure

◆ to_json_impl()

json dpp::user::to_json_impl ( bool with_id = true ) const

protectedvirtual

Convert to JSON.

Parameters

with_id include ID in output

Returns: json JSON output

Reimplemented in dpp::user_identified.

Friends And Related Function Documentation

◆ json_interface< user >

friend struct json_interface< user >

friend

Member Data Documentation

◆ avatar

utility::iconhash dpp::user::avatar

Avatar hash.

◆ avatar_decoration

utility::iconhash dpp::user::avatar_decoration

Avatar decoration hash.

◆ discriminator

uint16_t dpp::user::discriminator

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

Note: To print the discriminator with leading zeroes, use format_username(). 0 for users that have migrated to the new username format.

Referenced by dpp::user_identified::user_identified().

◆ flags

uint32_t dpp::user::flags

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

Referenced by format_username(), dpp::user_identified::get_banner_url(), get_mention(), get_url(), has_hypesquad_events(), has_nitro_basic(), has_nitro_classic(), has_nitro_full(), is_active_developer(), is_bot(), is_bughunter_1(), is_bughunter_2(), is_discord_employee(), is_early_supporter(), is_house_balance(), is_house_bravery(), is_house_brilliance(), is_mfa_enabled(), is_partnered_owner(), is_system(), is_team_user(), and is_verified().

◆ global_name

std::string dpp::user::global_name

Global display name.

◆ id

snowflake dpp::managed::id = {}

inherited

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 relevant to us as useful metadata.

Referenced by dpp::poll::add_answer(), dpp::cluster::create_webhook(), dpp::cluster::current_user_join_thread(), dpp::invite::fill_from_json_impl(), dpp::command_permission::fill_from_json_impl(), dpp::interaction::get_resolved_role(), dpp::interaction::get_resolved_user(), dpp::cluster::global_bulk_command_create(), dpp::cluster::global_bulk_command_delete(), dpp::cluster::global_command_delete(), dpp::cluster::global_command_edit(), dpp::cluster::guild_ban_delete(), dpp::cluster::guild_command_create(), dpp::cluster::guild_command_edit_permissions(), dpp::cluster::guild_get_integrations(), dpp::events::guild_member_update::handle(), dpp::events::guild_role_create::handle(), dpp::events::channel_create::handle(), dpp::events::voice_state_update::handle(), dpp::discord_voice_client::handle_frame(), main(), dpp::component::set_disabled(), and dpp::select_option::set_label().

◆ refcount

uint8_t dpp::user::refcount

Reference count of how many guilds this user is in.

◆ username

std::string dpp::user::username

Discord username.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ user()

◆ ~user()

Member Function Documentation

◆ build_json()

◆ fill_from_json()

◆ fill_from_json_impl()

◆ format_username()

◆ get_avatar_decoration_url()

◆ get_avatar_url()

◆ get_creation_time()

◆ get_default_avatar_url()

◆ get_mention() [1/2]

◆ get_mention() [2/2]

◆ get_url()

◆ has_animated_icon()

◆ has_hypesquad_events()

◆ has_nitro_basic()

◆ has_nitro_classic()

◆ has_nitro_full()

◆ is_active_developer()

◆ is_bot()

◆ is_bot_http_interactions()

◆ is_bughunter_1()

◆ is_bughunter_2()

◆ is_certified_moderator()

◆ is_discord_employee()

◆ is_early_supporter()

◆ is_house_balance()

◆ is_house_bravery()

◆ is_house_brilliance()

◆ is_mfa_enabled()

◆ is_partnered_owner()

◆ is_system()

◆ is_team_user()

◆ is_verified()

◆ is_verified_bot()

◆ is_verified_bot_dev()

◆ operator!=()

◆ operator==()

◆ to_json()

◆ to_json_impl()

Friends And Related Function Documentation

◆ json_interface< user >

Member Data Documentation

◆ avatar

◆ avatar_decoration

◆ discriminator

◆ flags

◆ global_name

◆ id

◆ refcount

◆ username