GuildBan | Pylon SDK Documentation

An object that represents a ban on a guild.

Note: If you need to ban a member or create a new ban, use discord.Guild.createBan.

Hierarchy

GuildBan <-- You are here!

Index

Properties

Methods

Properties

Readonly guildId

guildId: Snowflake

The id of the guild this ban belongs to.

Readonly reason

reason: string

A user-provided reason for the ban. If no reason was provided, the value will be "", an empty string.

Readonly user

user: User

The user banned from the guild.

Methods

delete

delete(): Promise<void>
Deletes the guild ban and un-bans the associated user from the guild.

Returns Promise<void>

getGuild

getGuild(): Promise<Guild>
Retrieves the discord.Guild associated with this ban.

If you only need the guild id, it's provided via the guildId property.

Returns Promise<Guild>

Generated using TypeDoc