Class MessageManager

The manager of messages that belong to a chat based channel.

Example

new MessageManager(channel);

Hierarchy

Constructors

constructor

Properties

cache channel client

Methods

create delete edit fetch setMaxCache

Constructors

constructor

Properties

Readonly cache

cache: CacheCollection<string, Message>

This cache of the manager.

Readonly channel

channel: ChatChannel

Readonly client

client: Client

Methods

create

  • Create a message in the chat based channel.

    Returns

    The created message.

    Example

    messages.create('Hello world!');

    Parameters

    Returns Promise<Message>

delete

  • Delete a message in the chat based channel.

    Example

    messages.delete(message);

    Parameters

    • message: string | Message

      The message to delete.

    Returns Promise<void>

edit

  • Edit a message in the chat based channel.

    Returns

    The edited message.

    Example

    messages.edit(message, 'Hello world!');

    Parameters

    Returns Promise<Message>

fetch

  • Fetch a message from the chat based channel, or cache.

    Returns

    The fetched message.

    Example

    messages.fetch(message);

    Parameters

    • message: string | Message

      The message to fetch.

    • Optional options: FetchOptions

      The options to fetch the message with.

    Returns Promise<Message>

  • Fetch messages from the chat based channel.

    Returns

    The fetched messages.

    Example

    messages.fetch();

    Parameters

    Returns Promise<Collection<string, Message>>

setMaxCache

  • Set the maximum cache size of the manager.

    Returns

    The manager.

    Example

    manager.setMaxCache(100);

    Parameters

    • maxSize: number

      The maximum size of the cache.

    Returns MessageManager

Settings

Member Visibility

Theme