Ban - truemedian/Discordia GitHub Wiki

Inherits Container

Represents a Discord guild ban. Essentially a combination of the banned user and a reason explaining the ban, if one was provided.

Methods

delete

Properties

reason
guild
user

Inherited from Container
client
parent

Methods

:delete( )

Deletes the ban object, essentially unbanning the corresponding user. Equivalent to Ban.guild:unbanUser(Ban.user).

Returns: boolean

Properties

.reason

The reason for the ban, if one was set. This should be from 1 to 512 characters in length.

Type: string|nil

.guild

The guild in which this ban object exists.

Type: Guild

.user

The user that this ban object represents.

Type: User

Inherited from Container

.client

A shortcut to the client object to which this container is visible.

Type: Client

.parent

The parent object of to which this container is a child. For example, the parent of a role is the guild in which the role exists.

Type: Container|Client

⚠️ **GitHub.com Fallback** ⚠️