Class MessageManager

Manages API methods for messages and stores their cache.

Hierarchy (View Summary)

CachedManager<Id, APIMessage, Message>
- MessageManager

Index

Constructors

Properties

cache client holds

Methods

_add _remove createHeld delete fetch

Constructors

constructor

new MessageManager(channel: Channel): MessageManager
Parameters
- channel: Channel
Returns MessageManager
Overrides CachedManager.constructor
- Defined in packages/foxochat.js/src/managers/MessageManager/MessageManager.ts:10

Properties

`Readonly`cache

cache: Map<number, Message> = ...

The cache of items for this manager.

`Readonly`client

client: Client

The client that instantiated this Manager.

`Protected` `Readonly`holds

holds: Newable<Message>

The data structure belonging to this manager.

Methods

_add

_add(key: number, data: APIMessage): Message
Adds an entry to the cache or updates an existing one.
Parameters
- key: number
- data: APIMessage
Returns Message
Inherited from CachedManager._add
- Defined in packages/foxochat.js/src/managers/CachedManager.ts:29

_remove

_remove(key: number): boolean
Removes an entry from the cache.
Parameters
- key: number
Returns boolean
Inherited from CachedManager._remove
- Defined in packages/foxochat.js/src/managers/CachedManager.ts:46

`Protected`createHeld

createHeld(data: APIMessage): Message
Parameters
- data: APIMessage
Returns Message
Overrides CachedManager.createHeld
- Defined in packages/foxochat.js/src/managers/MessageManager/MessageManager.ts:59

delete

delete(id: number): Promise<void>
Deletes the message.
Parameters
- id: number
Returns Promise<void>
- Defined in packages/foxochat.js/src/managers/MessageManager/MessageManager.ts:17

fetch

fetch(id: number): Promise<Message>
Obtains a message from API, or the message cache if it's already available.
Parameters
- id: number
Returns Promise<Message>
- Defined in packages/foxochat.js/src/managers/MessageManager/MessageManager.ts:24
fetch(options: FetchMessageOptions): Promise<Message>
Obtains a message from API, or the message cache if it's already available.
Parameters
- options: FetchMessageOptions
Returns Promise<Message>
- Defined in packages/foxochat.js/src/managers/MessageManager/MessageManager.ts:25
fetch(options?: FetchMessagesOptions): Promise<Map<number, Message>>
Obtains a message from API, or the message cache if it's already available.
Parameters
- Optionaloptions: FetchMessagesOptions
Returns Promise<Map<number, Message>>
- Defined in packages/foxochat.js/src/managers/MessageManager/MessageManager.ts:26