Class ChannelMessagesController

Provides an interface for a text channel's messages cache. The messages are mapped by their IDs

Hierarchy

BaseFetchController<Message>
- ChannelMessagesController

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ChannelMessagesController(channel: TextBasedChannel): ChannelMessagesController

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

Properties

cache

cache: ControllerCache<Message>

The cached data this controller contains

Readonly channel

channel: TextBasedChannel

The guild this controller is associated to

Methods

delete

delete(id: Snowflake): Promise<void>

- Defined in src/controllers/channel/ChannelMessagesController.ts:54
Deletes a message in the channel

Parameters
- id: Snowflake
  
  The ID of the message you wish to delete
Returns Promise<void>

fetch

fetch(id: Snowflake): Promise<Message>

Overrides BaseFetchController.fetch
- Defined in src/controllers/channel/ChannelMessagesController.ts:63
Fetches and caches a message in the channel

Parameters
- id: Snowflake
  
  The ID of the message you wish to fetch
Returns Promise<Message>

fetchSome

fetchSome(options?: FetchSomeMessagesOptions): Promise<Collection<Snowflake, Message>>

- Defined in src/controllers/channel/ChannelMessagesController.ts:76
Fetches and caches some messages in the channel

Parameters
- Optional options: FetchSomeMessagesOptions
  
  The options for the fetch operation
Returns Promise<Collection<Snowflake, Message>>

get

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

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

Generated using TypeDoc