Class ChannelPinsController

Interface for a text channel's pinned messages cache. The pinned messages are mapped by their IDs

Hierarchy

BaseFetchAllController<Message>
- ChannelPinsController

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ChannelPinsController(channel: TextBasedChannel): ChannelPinsController

Overrides BaseController.constructor
- Defined in src/controllers/channel/ChannelPinsController.ts:20
Parameters
- channel: TextBasedChannel
Returns ChannelPinsController

Properties

cache

cache: ControllerCache<Message>

The cached data this controller contains

channel

channel: TextBasedChannel

The channel associated to this controller

lastPinTimestamp

lastPinTimestamp: Timestamp | undefined

Timestamp of when the last pinned message was pinned

Methods

fetchAll

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

Overrides BaseFetchAllController.fetchAll
- Defined in src/controllers/channel/ChannelPinsController.ts:32
Fetches all messages in the text channel and caches them

Returns Promise<Collection<Snowflake, Message>>

pin

pin(id: Snowflake): Promise<void>

- Defined in src/controllers/channel/ChannelPinsController.ts:46
Pins a message in a text channel. Requires the Permission.ManageMessages permission

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

unpin

unpin(id: Snowflake): Promise<void>

- Defined in src/controllers/channel/ChannelPinsController.ts:60
Unpins a message in a text channel. Requires the Permission.ManageMessages permission

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

Generated using TypeDoc