Appearance
GuildBan
Package: @erinjs/core
Represents a ban in a guild.
Constructor
| Name | Type | Optional | Description |
|---|---|---|---|
client | Client | No | |
data | any | No | API ban from GET /guilds/{id}/bans or gateway GUILD_BAN_ADD |
guildId | string | No |
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
client | Client | Yes | No | |
expiresAt | string | null | Yes | No | ISO timestamp when a temporary ban expires. Null for permanent bans. |
guildId | string | Yes | No | |
reason | string | null | Yes | No | |
user | User | Yes | No |
Methods
unban() async
Remove this ban (unban the user). Requires Ban Members permission.
Returns: Promise<void>
Parameters:
None