GuildBan

GuildBan ⇐ Base

Represents a ban for a user in a guild.

Kind: global class
Extends: Base

• GuildBan ⇐ Base
  • new GuildBan(data, guildId, client)
  • .partial : boolean
  • .reason : string
  • .user
  • .guildId : string
  • .guild : Guild
  • .fetch([options]) ⇒ Promise.<GuildBan>
  • .remove([options]) ⇒ Promise.<GuildBan>

new GuildBan(data, guildId, client)

Param	Type	Description
data	Object	The data for the ban.
guildId	string	The ID of the guild.
client	Client	The instantiating client

guildBan.partial : boolean

Whether or not the ban is partial.

Kind: instance property of GuildBan

guildBan.reason : string

The reason for the ban.

Kind: instance property of GuildBan

guildBan.user

The user who was banned.

Kind: instance property of GuildBan

guildBan.guildId : string

The ID of the guild the ban was issued in.

Kind: instance property of GuildBan

guildBan.guild : Guild

The guild that this ban was issued in.

Kind: instance property of GuildBan
Read only: true

guildBan.fetch([options]) ⇒ Promise.<GuildBan>

Fetches this ban from the API.

Kind: instance method of GuildBan

Param	Type	Description
[options]	Object	Additional options for the fetch.

guildBan.remove([options]) ⇒ Promise.<GuildBan>

Fetches this ban from the API.

Kind: instance method of GuildBan

Param	Type	Description
[options]	Object	Additional options for the fetch.