dpp::prune Struct Reference

Defines a request to count prunable users, or start a prune operation. More...

#include <prune.h>

Inheritance diagram for dpp::prune:

Collaboration diagram for dpp::prune:

Public Member Functions
prune &	fill_from_json (nlohmann::json *j)
virtual std::string	build_json (bool with_prune_count=false) const
prune &	parse_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. More...

Public Attributes
uint32_t	days = 0
std::vector< snowflake >	include_roles
bool	compute_prune_count

Detailed Description

Defines a request to count prunable users, or start a prune operation.

Member Function Documentation

build_json()

virtual std::string dpp::prune::build_json ( bool  with_prune_count = false ) const

virtual

Build JSON from this object.

Parameters

with_prune_count

True if the prune count boolean is to be set in the built JSON

Returns

The JSON text of the prune object

Reimplemented from dpp::json_interface< prune >.

fill_from_json()

prune & dpp::prune::fill_from_json

(

nlohmann::json *

j

)

Fill this object from json.

Parameters

j	JSON object to fill from

Returns

A reference to self

parse_from_json()

prune & dpp::json_interface< prune >::parse_from_json ( nlohmann::json *  j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns

T& Reference to self for fluent calling

Member Data Documentation

compute_prune_count

bool dpp::prune::compute_prune_count

True if the count of pruneable users should be returned (discord recommend not using this on big guilds)

days

uint32_t dpp::prune::days = 0

Number of days to include in the prune

include_roles

std::vector<snowflake> dpp::prune::include_roles

Roles to include in the prune (empty to include everyone)