Class GuildInvitesController

Provides an interface for a guild's invites cache The invites are mapped by their invite codes

Hierarchy

BaseFetchController<Invite>
- GuildInvitesController

Implements

Index

Constructors

constructor

Properties

cache
guild

Methods

Constructors

constructor

new GuildInvitesController(guild: Guild): GuildInvitesController

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

Properties

cache

cache: ControllerCache<Invite>

The cached data this controller contains

Readonly guild

guild: Guild

The guild this controller is associated to

Methods

delete

delete(code: Snowflake): Promise<Invite>

- Defined in src/controllers/guild/GuildInvitesController.ts:39
Delete an invite by its invite code

Parameters
- code: Snowflake
  
  The invite code
Returns Promise<Invite>

fetch

fetch(code: string, options?: FetchInviteOptions): Promise<Invite>

Overrides BaseFetchController.fetch
- Defined in src/controllers/guild/GuildInvitesController.ts:49
Fetches an invite by its invite code

Parameters
- code: string
  
  The invite code
- Optional options: FetchInviteOptions
  
  An additional set of options for the invite
Returns Promise<Invite>

fetchAll

fetchAll(): Promise<Collection<string, Invite>>

- Defined in src/controllers/guild/GuildInvitesController.ts:62
Fetches all invites (with metadata) in this guild. Requires the Permission.ManageGuild permission

Returns Promise<Collection<string, Invite>>

get

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

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<Invite>

Generated using TypeDoc