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

Warning

doxygenstruct: Cannot find class “discord_begin_guild_prune_params” in doxygen xml output for project “Orca” from directory: ../xml