dpp::invite Class Reference

Represents an invite to a discord guild or channel. More...

#include <invite.h>

Inheritance diagram for dpp::invite:

Collaboration diagram for dpp::invite:

Public Member Functions
	invite ()
virtual	~invite ()=default
invite &	set_max_age (const uint32_t max_age_)
	Set the max age after which the invite expires. More...
invite &	set_max_uses (const uint8_t max_uses_)
	Set the maximum number of uses for this invite. More...
invite &	set_target_user_id (const snowflake user_id)
	Set the target user id. More...
invite &	set_target_type (const invite_target_t type)
	Set the target type for this voice channel invite. More...
invite &	set_temporary (const bool is_temporary)
	Set temporary property of this invite object. More...
invite &	set_unique (const bool is_unique)
	Set unique property of this invite object. More...
invite &	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
std::string	code
time_t	expires_at
snowflake	guild_id
guild	destination_guild
snowflake	channel_id
channel	destination_channel
snowflake	inviter_id
user	inviter
snowflake	target_user_id
invite_target_t	target_type
uint32_t	approximate_presence_count
uint32_t	approximate_member_count
uint32_t	max_age
uint8_t	max_uses
bool	temporary
bool	unique
uint32_t	uses
stage_instance	stage
time_t	created_at

Protected Member Functions
invite &	fill_from_json_impl (nlohmann::json *j)
virtual json	to_json_impl (bool with_id=false) const

Friends
struct	json_interface< invite >

Detailed Description

Represents an invite to a discord guild or channel.

Constructor & Destructor Documentation

invite()

dpp::invite::invite

(

)

Constructor

~invite()

virtual dpp::invite::~invite ( )

virtualdefault

Destructor

Member Function Documentation

build_json()

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

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

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

protected

Read class values from json object

Parameters

j	A json object to read from

Returns

A reference to self

set_max_age()

invite & dpp::invite::set_max_age

(

const uint32_t

max_age_

)

Set the max age after which the invite expires.

Parameters

max_age_

The duration in seconds, or 0 for no expiration. Must be between 0 and 604800 (7 days)

Returns

invite& reference to self for chaining of calls

set_max_uses()

invite & dpp::invite::set_max_uses

(

const uint8_t

max_uses_

)

Set the maximum number of uses for this invite.

Parameters

max_uses_

Maximum number of uses, or 0 for unlimited. Must be between 0 and 100

Returns

invite& reference to self for chaining of calls

set_target_type()

invite & dpp::invite::set_target_type

(

const invite_target_t

type

)

Set the target type for this voice channel invite.

Parameters

type	invite_target_t Target type

Returns

invite& reference to self for chaining of calls

set_target_user_id()

invite & dpp::invite::set_target_user_id

(

const snowflake

user_id

)

Set the target user id.

Parameters

user_id

The user ID whose stream to display for this voice channel stream invite

Returns

invite& reference to self for chaining of calls

set_temporary()

invite & dpp::invite::set_temporary

(

const bool

is_temporary

)

Set temporary property of this invite object.

Parameters

is_temporary

Whether this invite only grants temporary membership

Returns

invite& reference to self for chaining of calls

set_unique()

invite & dpp::invite::set_unique

(

const bool

is_unique

)

Set unique property of this invite object.

Parameters

is_unique

True if this invite should not replace or "attach to" similar invites

Returns

invite& reference to self for chaining of calls

to_json()

auto dpp::json_interface< invite >::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()

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

protectedvirtual

Build JSON from this object.

Parameters

with_id

Include ID in JSON

Returns

The JSON of the invite

Friends And Related Function Documentation

json_interface< invite >

friend struct json_interface< invite >

friend

Member Data Documentation

approximate_member_count

uint32_t dpp::invite::approximate_member_count

Approximate number of total users online and offline

Note

Only returned from cluster::invite_get

approximate_presence_count

uint32_t dpp::invite::approximate_presence_count

Approximate number of online users

Note

Only returned from cluster::invite_get

channel_id

snowflake dpp::invite::channel_id

Channel ID this invite is for

code

std::string dpp::invite::code

Invite code

created_at

time_t dpp::invite::created_at

Timestamp at which the invite was created

destination_channel

channel dpp::invite::destination_channel

The partial channel this invite is for. Only filled in retrieved invites

destination_guild

guild dpp::invite::destination_guild

The partial guild this invite is for. Only filled in retrieved invites

expires_at

time_t dpp::invite::expires_at

Readonly expiration timestamp of this invite or 0 if the invite doesn't expire

Note

Only returned from cluster::invite_get

guild_id

snowflake dpp::invite::guild_id

Guild ID this invite is for

inviter

user dpp::invite::inviter

User who created this invite

inviter_id

snowflake dpp::invite::inviter_id

User ID who created this invite

Deprecated:

Use the inviter field instead

max_age

uint32_t dpp::invite::max_age

Duration (in seconds) after which the invite expires, or 0 for no expiration. Must be between 0 and 604800 (7 days). Defaults to 86400 (1 day)

max_uses

uint8_t dpp::invite::max_uses

Maximum number of uses, or 0 for unlimited. Must be between 0 and 100. Defaults to 0

stage

stage_instance dpp::invite::stage

The stage instance data if there is a public stage instance in the stage channel this invite is for

Deprecated:

Deprecated

target_type

invite_target_t dpp::invite::target_type

Target type for this voice channel invite

target_user_id

snowflake dpp::invite::target_user_id

The user ID whose stream to display for this voice channel stream invite

temporary

bool dpp::invite::temporary

Whether this invite only grants temporary membership

unique

bool dpp::invite::unique

True if this invite should not replace or "attach to" similar invites

uses

uint32_t dpp::invite::uses

How many times this invite has been used