Class GuildIntegrationsController

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

Hierarchy

BaseFetchAllController<GuildIntegration>
- GuildIntegrationsController

Implements

BaseDeleteController<GuildIntegration>

Index

Constructors

constructor

Properties

cache
guild

Methods

Constructors

constructor

new GuildIntegrationsController(guild: Guild): GuildIntegrationsController

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

Properties

cache

cache: ControllerCache<GuildIntegration>

The cached data this controller contains

guild

guild: Guild

The guild associated to this controller

Methods

create

create(options: CreateIntegrationOptions): Promise<void>

- Defined in src/controllers/guild/GuildIntegrationsController.ts:42
Attaches an integration from the Bot to this guild. Requires the Permission.ManageGuild permission

Parameters
- options: CreateIntegrationOptions
  
  The options for the new integration
Returns Promise<void>

delete

delete(id: Snowflake): Promise<void>

- Defined in src/controllers/guild/GuildIntegrationsController.ts:52
Deletes the attached integration for this guild. Requires the Permission.ManageGuild permission

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

fetchAll

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

Overrides BaseFetchAllController.fetchAll
- Defined in src/controllers/guild/GuildIntegrationsController.ts:28
Fetches all guild integrations in this guild Requires the Permission.ManageGuild permission

Returns Promise<Collection<Snowflake, GuildIntegration>>

Generated using TypeDoc