dpp::integration Class Reference

Represents an integration on a guild, e.g. a connection to twitch. More...

#include <integration.h>

Inheritance diagram for dpp::integration:

Collaboration diagram for dpp::integration:

Public Member Functions
	integration ()
	~integration ()
integration &	fill_from_json (nlohmann::json *j)
virtual std::string	build_json (bool with_id=false) const
bool	emoticons_enabled () const
bool	is_enabled () const
bool	is_syncing () const
bool	is_revoked () const
bool	expiry_kicks_user () const
double	get_creation_time () const
	Get the creation time of this object according to Discord. More...
bool	operator== (const managed &other) const noexcept
	Comparison operator for comparing two managed objects by id. More...
bool	operator!= (const managed &other) const noexcept
	Comparison operator for comparing two managed objects by id. More...

Public Attributes
std::string	name
integration_type	type
uint8_t	flags
snowflake	role_id
snowflake	user_id
uint32_t	expire_grace_period
time_t	synced_at
uint32_t	subscriber_count
std::string	account_id
std::string	account_name
integration_app	app
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 relevant to us as useful metadata. More...

Detailed Description

Represents an integration on a guild, e.g. a connection to twitch.

Constructor & Destructor Documentation

integration()

dpp::integration::integration

(

)

Default constructor

~integration()

dpp::integration::~integration

(

)

Default destructor

Member Function Documentation

build_json()

virtual std::string dpp::integration::build_json ( bool  with_id = false ) const

virtual

Build a json string from this object.

Parameters

with_id

Add ID to output

Returns

JSON string of the object

Reimplemented from dpp::json_interface< integration >.

emoticons_enabled()

bool dpp::integration::emoticons_enabled

(

)

const

True if emoticons are enabled

expiry_kicks_user()

bool dpp::integration::expiry_kicks_user

(

)

const

True if expiring kicks the user

fill_from_json()

integration & dpp::integration::fill_from_json

(

nlohmann::json *

j

)

Read class values from json object

Parameters

j	A json object to read from

Returns

A reference to self

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.

is_enabled()

bool dpp::integration::is_enabled

(

)

const

True if integration is enabled

is_revoked()

bool dpp::integration::is_revoked

(

)

const

True if has been revoked

is_syncing()

bool dpp::integration::is_syncing

(

)

const

True if is syncing

operator!=()

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

noexceptinherited

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

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

noexceptinherited

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

Member Data Documentation

account_id

std::string dpp::integration::account_id

account_name

std::string dpp::integration::account_name

app

integration_app dpp::integration::app

expire_grace_period

uint32_t dpp::integration::expire_grace_period

Expiry grace period

flags

uint8_t dpp::integration::flags

Integration flags from dpp::integration_flags

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.

name

std::string dpp::integration::name

Integration name

role_id

snowflake dpp::integration::role_id

Role id

subscriber_count

uint32_t dpp::integration::subscriber_count

Subscriber count

synced_at

time_t dpp::integration::synced_at

Sync time

type

integration_type dpp::integration::type

Integration type

user_id

snowflake dpp::integration::user_id

User id