Begin Guild Prune#

ORCAcode discord_begin_guild_prune(struct discord *client, u64_snowflake_t guild_id, struct discord_begin_guild_prune_params *params)#

Begin guild prune operation.

Note

Discord recommends for larger servers to set “compute_prune_count” to false

Note

Requires the KICK_MEMBERS permission

Note

Fires multiple Guild Member Remove events

Parameters:

  • client – the client created with discord_init()

  • guild_id – the unique id of the guild to start the prune

Returns:

ORCAcode for how the operation went, ORCA_OK means nothing out of the ordinary

struct discord_begin_guild_prune_params#

Methods

  • Initializer:

    • void discord_begin_guild_prune_params_init(struct discord_begin_guild_prune_params *)

  • Cleanup:

    • void discord_begin_guild_prune_params_cleanup(struct discord_begin_guild_prune_params *)

    • void discord_begin_guild_prune_params_list_free(struct discord_begin_guild_prune_params **)

  • JSON Decoder:

    • void discord_begin_guild_prune_params_from_json(char *rbuf, size_t len, struct discord_begin_guild_prune_params *)

    • void discord_begin_guild_prune_params_list_from_json(char *rbuf, size_t len, struct discord_begin_guild_prune_params ***)

  • JSON Encoder:

    • void discord_begin_guild_prune_params_to_json(char *wbuf, size_t len, struct discord_begin_guild_prune_params *)

    • void discord_begin_guild_prune_params_list_to_json(char *wbuf, size_t len, struct discord_begin_guild_prune_params **)

Public Members

int days#
bool compute_prune_count#
ja_u64 **include_roles#
char *reason#