Struct CreateBan

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

Bans a user from a guild, optionally with the number of days’ worth of messages to delete and the reason.

Examples

Ban user 200 from guild 100, deleting 1 day’s (86_400 second’s) worth of messages, for the reason "memes":

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

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

let guild_id = Id::new(100);
let user_id = Id::new(200);
client
    .create_ban(guild_id, user_id)
    .delete_message_seconds(86_400)
    .reason("memes")
    .await?;

Implementations

impl<'a> CreateBan<'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).

Errors

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

Trait Implementations

impl<'a> AuditLogReason<'a> for CreateBan<'a>

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

Attach an audit log reason to the request.

impl IntoFuture for CreateBan<'_>

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

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<EmptyBody>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for CreateBan<'_>

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

Try to convert a request builder into a raw Request.