Class GuildBansController

Provides an interface for a guild's bans cache. The bans are mapped by their banned user IDs

Hierarchy

BaseFetchController<GuildBan>
- GuildBansController

Implements

Index

Constructors

constructor

Properties

cache
guild

Methods

Constructors

constructor

new GuildBansController(guild: Guild): GuildBansController

Overrides BaseController.constructor
- Defined in src/controllers/guild/GuildBansController.ts:15
Parameters
- guild: Guild
Returns GuildBansController

Properties

cache

cache: ControllerCache<GuildBan>

The cached data this controller contains

Readonly guild

guild: Guild

The guild associated to this controller

Methods

delete

delete(id: Snowflake): Promise<void>

- Defined in src/controllers/guild/GuildBansController.ts:54
Unbans a member from the guild. Requires the Permission.BanMembers permission

Parameters
- id: Snowflake
  
  The ID of the member
Returns Promise<void>

fetch

fetch(id: Snowflake): Promise<GuildBan>

Overrides BaseFetchController.fetch
- Defined in src/controllers/guild/GuildBansController.ts:40
Fetches a guild ban by a user ID

Parameters
- id: Snowflake
  
  The ID of the user
Returns Promise<GuildBan>

fetchAll

fetchAll(): Promise<Collection<Snowflake, GuildBan>>

- Defined in src/controllers/guild/GuildBansController.ts:27
Fetches all bans in the guilds

Returns Promise<Collection<Snowflake, GuildBan>>

get

get(id: Snowflake | string): Promise<GuildBan>

Inherited from BaseFetchController.get
- Defined in src/controllers/base/BaseFetchController.ts:22
Returns an already cached item or fetches it

Parameters
- id: Snowflake | string
  
  The ID of the item you wish to get or fetch
Returns Promise<GuildBan>

Generated using TypeDoc