Method BanAsync

Namespace

DisCatSharp.Entities

Assembly

DisCatSharp.dll

BanAsync(int, string?, CancellationToken)

Bans this member from their guild.

public Task BanAsync(int deleteMessageSeconds = 0, string? reason = null, CancellationToken cancellationToken = default)

Parameters

deleteMessageSeconds int

How many seconds of messages to delete. Minimum 0 seconds and maximum 604800 seconds (7 days).

reason string

Reason for audit logs.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task

Exceptions

UnauthorizedException

Thrown when the client does not have the BanMembers permission.

NotFoundException

Thrown when the member does not exist.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.