dpp::presence Class Reference

Represents user presence, e.g. what game they are playing and if they are online. More...

#include <presence.h>

Collaboration diagram for dpp::presence:

Public Member Functions
	presence ()
	presence (presence_status status, activity_type type, const std::string &activity_description)
	Construct a new presence object with some parameters for sending to a websocket. More...
	presence (presence_status status, activity a)
	Construct a new presence object with some parameters for sending to a websocket. More...
	~presence ()
presence &	fill_from_json (nlohmann::json *j)
std::string	build_json () const
presence_status	desktop_status () const
presence_status	web_status () const
presence_status	mobile_status () const
presence_status	status () const

Public Attributes
snowflake	user_id
snowflake	guild_id
uint8_t	flags
std::vector< activity >	activities

Detailed Description

Represents user presence, e.g. what game they are playing and if they are online.

Constructor & Destructor Documentation

presence() [1/3]

dpp::presence::presence

(

)

Constructor

presence() [2/3]

dpp::presence::presence	(	presence_status	status,
		activity_type	type,
		const std::string &	activity_description
	)

Construct a new presence object with some parameters for sending to a websocket.

Parameters

status
type
activity_description

presence() [3/3]

dpp::presence::presence	(	presence_status	status,
		activity	a
	)

Construct a new presence object with some parameters for sending to a websocket.

Parameters

status
a	Activity itself

~presence()

dpp::presence::~presence

(

)

Destructor

Member Function Documentation

build_json()

std::string dpp::presence::build_json

(

)

const

Build JSON from this object.

Returns

The JSON text of the presence

desktop_status()

presence_status dpp::presence::desktop_status

(

)

const

The users status on desktop

Returns

The user's status on desktop

fill_from_json()

presence & dpp::presence::fill_from_json

(

nlohmann::json *

j

)

Fill this object from json.

Parameters

j	JSON object to fill from

Returns

A reference to self

mobile_status()

presence_status dpp::presence::mobile_status

(

)

const

The user's status on mobile

Returns

The user's status on mobile

status()

presence_status dpp::presence::status

(

)

const

The user's status as shown to other users

Returns

The user's status as shown to other users

web_status()

presence_status dpp::presence::web_status

(

)

const

The user's status on web

Returns

The user's status on web

Member Data Documentation

activities

std::vector<activity> dpp::presence::activities

List of activities

flags

uint8_t dpp::presence::flags

Flags bitmask containing presence_flags

guild_id

snowflake dpp::presence::guild_id

Guild ID. Apparently, Discord supports this internally but the client doesnt...

user_id

snowflake dpp::presence::user_id

The user the presence applies to