pub struct CreateBan<'a> { /* private fields */ }
Expand description
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 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_days(1)?
.reason("memes")?
.exec()
.await?;
Implementations
sourceimpl<'a> CreateBan<'a>
impl<'a> CreateBan<'a>
sourcepub const fn delete_message_days(
self,
days: u16
) -> Result<Self, ValidationError>
pub const fn delete_message_days(
self,
days: u16
) -> Result<Self, ValidationError>
Set the number of days’ worth of messages to delete.
The number of days must be less than or equal to 7.
Errors
Returns an error of type CreateGuildBanDeleteMessageDays
if the
number of days is greater than 7.
sourcepub fn exec(self) -> ResponseFuture<EmptyBody>ⓘNotable traits for ResponseFuture<T>impl<T: Unpin> Future for ResponseFuture<T> type Output = Result<Response<T>, Error>;
pub fn exec(self) -> ResponseFuture<EmptyBody>ⓘNotable traits for ResponseFuture<T>impl<T: Unpin> Future for ResponseFuture<T> type Output = Result<Response<T>, Error>;
Execute the request, returning a future resolving to a Response
.
Trait Implementations
sourceimpl<'a> AuditLogReason<'a> for CreateBan<'a>
impl<'a> AuditLogReason<'a> for CreateBan<'a>
sourceimpl TryIntoRequest for CreateBan<'_>
impl TryIntoRequest for CreateBan<'_>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for CreateBan<'a>
impl<'a> Send for CreateBan<'a>
impl<'a> Sync for CreateBan<'a>
impl<'a> Unpin for CreateBan<'a>
impl<'a> !UnwindSafe for CreateBan<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more