Class GuildChannelInvitesController

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

Hierarchy

BaseFetchAllController<Invite>
- GuildChannelInvitesController

Implements

BaseCreateController<Invite, InviteOptions>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GuildChannelInvitesController(channel: GuildChannel): GuildChannelInvitesController

Overrides BaseController.constructor
- Defined in src/controllers/guild/GuildChannelInvitesController.ts:15
Parameters
- channel: GuildChannel
Returns GuildChannelInvitesController

Properties

cache

cache: ControllerCache<Invite>

The cached data this controller contains

Readonly channel

channel: GuildChannel

The channel this controller is associated to

Methods

create

create(options?: InviteOptions): Promise<Invite>

- Defined in src/controllers/guild/GuildChannelInvitesController.ts:42
Creates a new invite for a guild channel. Requires the Permission.CreateInstantInvite permission

Parameters
- Optional options: InviteOptions
  
  The new invite options
Returns Promise<Invite>

fetchAll

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

Overrides BaseFetchAllController.fetchAll
- Defined in src/controllers/guild/GuildChannelInvitesController.ts:28
Fetches all invites for this channel. Requires the Permission.ManageChannels permission

Returns Promise<Collection<string, Invite>>

Generated using TypeDoc