dpp::integration
dpp::managed
dpp::json_interface< integration >
integration.h
struct friend struct json_interface< integration > json_interface< integration > dpp::integration::json_interface< integration > json_interface< integration >
integration_account integration_account dpp::integration::account account dpp::integration::account

Integration account information.

integration_app integration_app dpp::integration::app app dpp::integration::app

The bot/OAuth2 application for discord integrations.

uint32_t uint32_t dpp::integration::expire_grace_period expire_grace_period dpp::integration::expire_grace_period

The grace period (in days) before expiring subscribers.

This is not provided for discord bot integrations.

uint8_t uint8_t dpp::integration::flags flags dpp::integration::flags

Integration flags from dpp::integration_flags.

snowflake snowflake dpp::managed::id id dpp::managed::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.

std::string std::string dpp::integration::name name dpp::integration::name

Integration name.

snowflake snowflake dpp::integration::role_id role_id dpp::integration::role_id

ID that this integration uses for "subscribers".

This is not provided for discord bot integrations.

std::vector< std::string > std::vector<std::string> dpp::integration::scopes scopes dpp::integration::scopes

The scopes the application has been authorized for.

uint32_t uint32_t dpp::integration::subscriber_count subscriber_count dpp::integration::subscriber_count

How many subscribers this integration has.

This is not provided for discord bot integrations.

time_t time_t dpp::integration::synced_at synced_at dpp::integration::synced_at

When this integration was last synced.

This is not provided for discord bot integrations.

integration_type integration_type dpp::integration::type type dpp::integration::type

Integration type (twitch, youtube, discord, or guild_subscription).

user user dpp::integration::user_obj user_obj dpp::integration::user_obj

User for this integration.

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

Read class values from json object j

A json object to read from

A reference to self

json virtual json dpp::integration::to_json_impl (bool with_id=false) const to_json_impl dpp::integration::to_json_impl bool with_id false

Build a json from this object. with_id

Add ID to output

JSON of the object

dpp::integration::integration
()
integration
dpp::integration::integration

Default constructor

dpp::integration::~integration
()=default
~integration
dpp::integration::~integration

Default destructor

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

Convert object to json string.

with_id

Whether to include the ID or not

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

std::string Json built from the structure

bool bool dpp::integration::emoticons_enabled () const emoticons_enabled dpp::integration::emoticons_enabled

Are emoticons enabled for this integration?

This is not provided for discord bot integrations.

bool bool dpp::integration::expiry_kicks_user () const expiry_kicks_user dpp::integration::expiry_kicks_user

Will the user be kicked if their subscription runs out to the integration? If false, the integration will simply remove the role that is specified by `role_id`.

This is not provided for discord bot integrations.

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

Convert object from nlohmann::json.

j

nlohmann::json object

T& Reference to self for fluent calling

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

Get the creation time of this object according to Discord.

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

bool bool dpp::integration::is_enabled () const is_enabled dpp::integration::is_enabled

Is the integration enabled?

This is not provided for discord bot integrations.

bool bool dpp::integration::is_revoked () const is_revoked dpp::integration::is_revoked

Has this integration been revoked?

This is not provided for discord bot integrations.

bool bool dpp::integration::is_syncing () const is_syncing dpp::integration::is_syncing

Is the integration syncing?

This is not provided for discord bot integrations.

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

Comparison operator for comparing two managed objects by id.

other

Other object to compare against

true objects are not the same id

false objects are the same id

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

Comparison operator for comparing two managed objects by id.

other

Other object to compare against

true objects are the same id

false objects are not the same id

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

Convert object to nlohmann::json.

with_id

Whether to include the ID or not

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

json Json built from the structure

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

dpp::integration
dpp::json_interface< T >
dpp::json_interface< integration >
< integration >
dpp::managed
T
bool
dpp::integration
name
type
flags
role_id
expire_grace_period
subscriber_count
user_obj
account
synced_at
app
scopes
dpp::integration_account
id
name
dpp::integration_app
id
description
name
icon
bot
dpp::json_interface< T >
dpp::json_interface< integration >
< integration >
dpp::json_interface< user >
< user >
dpp::managed
id
dpp::snowflake
value
dpp::user
global_name
username
avatar
avatar_decoration
primary_guild
flags
discriminator
refcount
dpp::utility::iconhash
first
second
dpp::utility::primaryguild
id
enabled
tag
badge
integration_type
std::basic_string< Char >
std::string
std::vector< T >
elements
std::vector< std::string >
elements
< std::string >
time_t
uint16_t
uint32_t
uint64_t
uint8_t
- dpp::integration
  account
- dpp::integration
  app
- dpp::integration
  build_json
- dpp::integration
  emoticons_enabled
- dpp::integration
  expire_grace_period
- dpp::integration
  expiry_kicks_user
- dpp::integration
  fill_from_json
- dpp::integration
  fill_from_json_impl
- dpp::integration
  flags
- dpp::integration
  get_creation_time
- dpp::integration
  id
- dpp::integration
  integration
- dpp::integration
  is_enabled
- dpp::integration
  is_revoked
- dpp::integration
  is_syncing
- dpp::integration
  json_interface< integration >
- dpp::integration
  managed
- dpp::integration
  managed
- dpp::integration
  managed
- dpp::integration
  managed
- dpp::integration
  name
- dpp::integration
  operator!=
- dpp::integration
  operator=
- dpp::integration
  operator=
- dpp::integration
  operator==
- dpp::integration
  role_id
- dpp::integration
  scopes
- dpp::integration
  subscriber_count
- dpp::integration
  synced_at
- dpp::integration
  to_json
- dpp::integration
  to_json_impl
- dpp::integration
  type
- dpp::integration
  user_obj
- dpp::integration
  ~integration
- dpp::integration
  ~managed