Struct BulkGuildBan 

pub struct BulkGuildBan<'a> { /* private fields */ }

Ban up to 200 users from a guild in bulk, optionally deleting their recent messages and specifying an Audit Log reason.

Requires both the BAN_MEMBERS and MANAGE_GUILD permissions.

Examples

Ban a list of users from a guild along with the last day’s messages:

use twilight_http::{Client, request::AuditLogReason};
use twilight_model::id::{Id, marker::UserMarker};

let client = Client::new("my token".to_owned());

let guild_id = Id::new(1);
let user_ids: Vec<Id<UserMarker>> = determine_users_to_ban();
client
    .bulk_guild_ban(guild_id, &user_ids)
    .delete_message_seconds(86_400)
    .reason("insulting my little pony")
    .await?;

Implementations

impl<'a> BulkGuildBan<'a>

pub fn delete_message_seconds(self, seconds: u32) -> Self

Set the number of seconds’ worth of messages to delete.

The number of seconds must be less than or equal to 604_800 (this is equivalent to 7 days).

Discord’s defaults this to 0 seconds.

Errors

Returns an error of type BulkGuildBanDeleteMessageSeconds if the number of seconds is greater than 604_800 (this is equivalent to 7 days).

Trait Implementations

impl<'a> AuditLogReason<'a> for BulkGuildBan<'a>

fn reason(self, reason: &'a str) -> Self

Attach an audit log reason to the request.

impl IntoFuture for BulkGuildBan<'_>

type Output = Result<Response<BulkGuildBanResponseBody>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<BulkGuildBanResponseBody>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for BulkGuildBan<'_>

fn try_into_request(self) -> Result<Request, Error>

Try to convert a request builder into a raw Request.