Skip to content

GuildBan

Package: @erinjs/core

Represents a ban in a guild.

Constructor

NameTypeOptionalDescription
clientClientNo
dataanyNoAPI ban from GET /guilds/{id}/bans or gateway GUILD_BAN_ADD
guildIdstringNo

Properties

NameTypeReadonlyOptionalDescription
clientClientYesNo
expiresAtstring | nullYesNoISO timestamp when a temporary ban expires. Null for permanent bans.
guildIdstringYesNo
reasonstring | nullYesNo
userUserYesNo

Methods

unban() async

Remove this ban (unban the user). Requires Ban Members permission.

Returns: Promise<void>

Parameters:

None

Released under the Apache-2.0 License.