dpp::thread_member Struct Reference

represents membership of a user with a thread More...

#include <thread.h>

Inheritance diagram for dpp::thread_member:

Collaboration diagram for dpp::thread_member:

Public Member Functions
thread_member &	fill_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...
auto	to_json (bool with_id=false) const
	Convert object to nlohmann::json. More...
std::string	build_json (bool with_id=false) const
	Convert object to json string. More...

Public Attributes
snowflake	thread_id = {}
	ID of the thread member is part of. More...
snowflake	user_id = {}
	ID of the member. More...
time_t	joined = 0
	The time when user last joined the thread. More...
uint32_t	flags = 0
	Any user-thread settings, currently only used for notifications. More...

Protected Member Functions
thread_member &	fill_from_json_impl (nlohmann::json *j)
	Read struct values from a json object. More...

Friends
struct	json_interface< thread_member >

Detailed Description

represents membership of a user with a thread

Member Function Documentation

build_json()

std::string dpp::json_interface< thread_member >::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()

thread_member & dpp::json_interface< thread_member >::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()

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

protected

Read struct values from a json object.

Parameters

j	json to read values from

Returns

A reference to self

to_json()

auto dpp::json_interface< thread_member >::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

Friends And Related Function Documentation

json_interface< thread_member >

friend struct json_interface< thread_member >

friend

Member Data Documentation

flags

uint32_t dpp::thread_member::flags = 0

Any user-thread settings, currently only used for notifications.

joined

time_t dpp::thread_member::joined = 0

The time when user last joined the thread.

thread_id

snowflake dpp::thread_member::thread_id = {}

ID of the thread member is part of.

user_id

snowflake dpp::thread_member::user_id = {}

ID of the member.