Class MessageManager

Hierarchy

BaseManager<BaseMessage>
- MessageManager

Index

Constructors

constructor

new MessageManager(client: Client, channel: Channel): MessageManager
Parameters
- client: Client
- channel: Channel
Returns MessageManager
Overrides BaseManager<BaseMessage>.constructor
- Defined in core/src/managers/MessageManager.ts:13

Properties

`Readonly` [toStringTag]

[toStringTag]: string

channel

channel: Channel

`Private` client

client: Client

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

ordered

get ordered(): BaseMessage[]
Ordered messages in this channel, oldest first.

Returns BaseMessage[]
- Defined in core/src/managers/MessageManager.ts:32

Methods

[iterator]

[iterator](): IterableIterator<[string, BaseMessage]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, BaseMessage]>
Inherited from BaseManager.__@iterator@11
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

bulkDelete

bulkDelete(ids: string[] | Message[]): Promise<void>
Delete multiple messages at once. (max 100, no older than 7 days)
Parameters
- ids: string[] | Message[]
Returns Promise<void>
- Defined in core/src/managers/MessageManager.ts:78

clear

clear(): void
Returns void
Inherited from BaseManager.clear
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

construct

construct(data: {
    _id: string;
    attachments?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }[];
    author: string;
    channel: string;
    content?: string;
    edited?: string;
    embeds?: ({
        colour?: string;
        description?: string;
        icon_url?: string;
        image?: {
            height: number;
            size: "Large" | "Preview";
            url: string;
            width: number;
        };
        original_url?: string;
        site_name?: string;
        special?: {
            type: "None";
        } | {
            type: "GIF";
        } | {
            id: string;
            timestamp?: string;
            type: "YouTube";
        } | {
            content_type: "Channel";
            id: string;
            type: "Lightspeed";
        } | {
            content_type: "Video" | "Channel" | "Clip";
            id: string;
            type: "Twitch";
        } | {
            content_type: string;
            id: string;
            type: "Spotify";
        } | {
            type: "Soundcloud";
        } | {
            content_type: "Album" | "Track";
            id: string;
            type: "Bandcamp";
        } | {
            id: string;
            type: "Streamable";
        };
        title?: string;
        type: "Website";
        url?: string;
        video?: {
            height: number;
            url: string;
            width: number;
        };
    } | {
        height: number;
        size: "Large" | "Preview";
        type: "Image";
        url: string;
        width: number;
    } | {
        height: number;
        type: "Video";
        url: string;
        width: number;
    } | {
        colour?: string;
        description?: string;
        icon_url?: string;
        media?: {
            _id: string;
            content_type: string;
            deleted?: boolean;
            filename: string;
            message_id?: string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: string;
            reported?: boolean;
            server_id?: string;
            size: number;
            tag: string;
            user_id?: string;
        };
        title?: string;
        type: "Text";
        url?: string;
    } | {
        type: "None";
    })[];
    interactions?: {
        reactions?: string[];
        restrict_reactions?: boolean;
    };
    masquerade?: {
        avatar?: string;
        colour?: string;
        name?: string;
    };
    mentions?: string[];
    nonce?: string;
    reactions?: {
        [key: string]: string[];
    };
    replies?: string[];
    system?: {
        content: string;
        type: "text";
    } | {
        by: string;
        id: string;
        type: "user_added";
    } | {
        by: string;
        id: string;
        type: "user_remove";
    } | {
        id: string;
        type: "user_joined";
    } | {
        id: string;
        type: "user_left";
    } | {
        id: string;
        type: "user_kicked";
    } | {
        id: string;
        type: "user_banned";
    } | {
        by: string;
        name: string;
        type: "channel_renamed";
    } | {
        by: string;
        type: "channel_description_changed";
    } | {
        by: string;
        type: "channel_icon_changed";
    } | {
        from: string;
        to: string;
        type: "channel_ownership_changed";
    };
    webhook?: {
        avatar?: string;
        name: string;
    };
}): BaseMessage
Parameters
- data: {
      _id: string;
      attachments?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      }[];
      author: string;
      channel: string;
      content?: string;
      edited?: string;
      embeds?: ({
          colour?: string;
          description?: string;
          icon_url?: string;
          image?: {
              height: number;
              size: "Large" | "Preview";
              url: string;
              width: number;
          };
          original_url?: string;
          site_name?: string;
          special?: {
              type: "None";
          } | {
              type: "GIF";
          } | {
              id: string;
              timestamp?: string;
              type: "YouTube";
          } | {
              content_type: "Channel";
              id: string;
              type: "Lightspeed";
          } | {
              content_type: "Video" | "Channel" | "Clip";
              id: string;
              type: "Twitch";
          } | {
              content_type: string;
              id: string;
              type: "Spotify";
          } | {
              type: "Soundcloud";
          } | {
              content_type: "Album" | "Track";
              id: string;
              type: "Bandcamp";
          } | {
              id: string;
              type: "Streamable";
          };
          title?: string;
          type: "Website";
          url?: string;
          video?: {
              height: number;
              url: string;
              width: number;
          };
      } | {
          height: number;
          size: "Large" | "Preview";
          type: "Image";
          url: string;
          width: number;
      } | {
          height: number;
          type: "Video";
          url: string;
          width: number;
      } | {
          colour?: string;
          description?: string;
          icon_url?: string;
          media?: {
              _id: string;
              content_type: string;
              deleted?: boolean;
              filename: string;
              message_id?: string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: string;
              reported?: boolean;
              server_id?: string;
              size: number;
              tag: string;
              user_id?: string;
          };
          title?: string;
          type: "Text";
          url?: string;
      } | {
          type: "None";
      })[];
      interactions?: {
          reactions?: string[];
          restrict_reactions?: boolean;
      };
      masquerade?: {
          avatar?: string;
          colour?: string;
          name?: string;
      };
      mentions?: string[];
      nonce?: string;
      reactions?: {
          [key: string]: string[];
      };
      replies?: string[];
      system?: {
          content: string;
          type: "text";
      } | {
          by: string;
          id: string;
          type: "user_added";
      } | {
          by: string;
          id: string;
          type: "user_remove";
      } | {
          id: string;
          type: "user_joined";
      } | {
          id: string;
          type: "user_left";
      } | {
          id: string;
          type: "user_kicked";
      } | {
          id: string;
          type: "user_banned";
      } | {
          by: string;
          name: string;
          type: "channel_renamed";
      } | {
          by: string;
          type: "channel_description_changed";
      } | {
          by: string;
          type: "channel_icon_changed";
      } | {
          from: string;
          to: string;
          type: "channel_ownership_changed";
      };
      webhook?: {
          avatar?: string;
          name: string;
      };
  }
  - _id: string
    
    Description
    Unique Id
  - Optional attachments?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }[]
    
    Description
    Array of attachments
  - author: string
    
    Description
    Id of the user or webhook that sent this message
  - channel: string
    
    Description
    Id of the channel this message was sent in
  - Optional content?: string
    
    Description
    Message content
  - Optional edited?: string
    
    Description
    Time at which this message was last edited
  - Optional embeds?: ({
        colour?: string;
        description?: string;
        icon_url?: string;
        image?: {
            height: number;
            size: "Large" | "Preview";
            url: string;
            width: number;
        };
        original_url?: string;
        site_name?: string;
        special?: {
            type: "None";
        } | {
            type: "GIF";
        } | {
            id: string;
            timestamp?: string;
            type: "YouTube";
        } | {
            content_type: "Channel";
            id: string;
            type: "Lightspeed";
        } | {
            content_type: "Video" | "Channel" | "Clip";
            id: string;
            type: "Twitch";
        } | {
            content_type: string;
            id: string;
            type: "Spotify";
        } | {
            type: "Soundcloud";
        } | {
            content_type: "Album" | "Track";
            id: string;
            type: "Bandcamp";
        } | {
            id: string;
            type: "Streamable";
        };
        title?: string;
        type: "Website";
        url?: string;
        video?: {
            height: number;
            url: string;
            width: number;
        };
    } | {
        height: number;
        size: "Large" | "Preview";
        type: "Image";
        url: string;
        width: number;
    } | {
        height: number;
        type: "Video";
        url: string;
        width: number;
    } | {
        colour?: string;
        description?: string;
        icon_url?: string;
        media?: {
            _id: string;
            content_type: string;
            deleted?: boolean;
            filename: string;
            message_id?: string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: string;
            reported?: boolean;
            server_id?: string;
            size: number;
            tag: string;
            user_id?: string;
        };
        title?: string;
        type: "Text";
        url?: string;
    } | {
        type: "None";
    })[]
    
    Description
    Attached embeds to this message
  - Optional interactions?: {
    reactions?: string[];
    restrict_reactions?: boolean;
    }
    
    Description
    Information about how this message should be interacted with
    - Optional reactions?: string[]
      
      Description
      Reactions which should always appear and be distinct
    - Optional restrict_reactions?: boolean
      
      Description
      Whether reactions should be restricted to the given list
      
      Can only be set to true if reactions list is of at least length 1
  - Optional masquerade?: {
        avatar?: string;
        colour?: string;
        name?: string;
    }
    
    Description
    Name and / or avatar overrides for this message
    - Optional avatar?: string
      
      Description
      Replace the avatar shown on this message (URL to image file)
    - Optional colour?: string
      
      Description
      Replace the display role colour shown on this message
      
      Must have ManageRole permission to use
    - Optional name?: string
      
      Description
      Replace the display name shown on this message
  - Optional mentions?: string[]
    
    Description
    Array of user ids mentioned in this message
  - Optional nonce?: string
    
    Description
    Unique value generated by client sending this message
  - Optional reactions?: {
    [key: string]: string[];
    }
    
    Description
    Hashmap of emoji IDs to array of user IDs
    - [key: string]: string[]
  - Optional replies?: string[]
    
    Description
    Array of message ids this message is replying to
  - Optional system?: {
        content: string;
        type: "text";
    } | {
        by: string;
        id: string;
        type: "user_added";
    } | {
        by: string;
        id: string;
        type: "user_remove";
    } | {
        id: string;
        type: "user_joined";
    } | {
        id: string;
        type: "user_left";
    } | {
        id: string;
        type: "user_kicked";
    } | {
        id: string;
        type: "user_banned";
    } | {
        by: string;
        name: string;
        type: "channel_renamed";
    } | {
        by: string;
        type: "channel_description_changed";
    } | {
        by: string;
        type: "channel_icon_changed";
    } | {
        from: string;
        to: string;
        type: "channel_ownership_changed";
    }
    
    Description
    System message
  - Optional webhook?: {
    avatar?: string;
    name: string;
    }
    
    Description
    The webhook that sent this message
    - Optional avatar?: string
    - name: string
Returns BaseMessage
- Defined in core/src/managers/MessageManager.ts:17

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
Inherited from BaseManager.delete
- Defined in core/src/managers/BaseManager.ts:14

entries

entries(): IterableIterator<[string, BaseMessage]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, BaseMessage]>
Inherited from BaseManager.entries
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

fetch

fetch(id: string): Promise<BaseMessage>
Parameters
- id: string
Returns Promise<BaseMessage>
- Defined in core/src/managers/MessageManager.ts:36

fetchMultiple

fetchMultiple(params?: {
    after?: string;
    before?: string;
    include_users?: boolean;
    limit?: number;
    nearby?: string;
    sort?: "Relevance" | "Latest" | "Oldest";
}): Promise<BaseMessage[]>
Parameters
- Optional params: {
      after?: string;
      before?: string;
      include_users?: boolean;
      limit?: number;
      nearby?: string;
      sort?: "Relevance" | "Latest" | "Oldest";
  }
  - Optional after?: string
    
    Message id after which messages should be fetched
  - Optional before?: string
    
    Message id before which messages should be fetched
  - Optional include_users?: boolean
    
    Whether to include user (and member, if server channel) objects
  - Optional limit?: number
    
    Maximum number of messages to fetch
    
    For fetching nearby messages, this is (limit + 1).
  - Optional nearby?: string
    
    Message id to search around
    
    Specifying 'nearby' ignores 'before', 'after' and 'sort'. It will also take half of limit rounded as the limits to each side. It also fetches the message ID specified.
  - Optional sort?: "Relevance" | "Latest" | "Oldest"
    
    Message sort direction
Returns Promise<BaseMessage[]>
- Defined in core/src/managers/MessageManager.ts:41

filter

filter(...d: [predicate: ((value: BaseMessage, index: number, array: BaseMessage[]) => unknown), thisArg?: any]): BaseMessage[]
Parameters
- Rest ...d: [predicate: ((value: BaseMessage, index: number, array: BaseMessage[]) => unknown), thisArg?: any]
Returns BaseMessage[]
Inherited from BaseManager.filter
- Defined in core/src/managers/BaseManager.ts:27

find

find(...d: [predicate: ((value: BaseMessage, index: number, obj: BaseMessage[]) => unknown), thisArg?: any]): BaseMessage
Parameters
- Rest ...d: [predicate: ((value: BaseMessage, index: number, obj: BaseMessage[]) => unknown), thisArg?: any]
Returns BaseMessage
Inherited from BaseManager.find
- Defined in core/src/managers/BaseManager.ts:24

fireUpdate

fireUpdate(updated?: BaseMessage[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: BaseMessage[]
  
  The objects that caused this update.
Returns void
Inherited from BaseManager.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:67

forEach

forEach(callbackfn: ((value: BaseMessage, key: string, map: Map<string, BaseMessage>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: BaseMessage, key: string, map: Map<string, BaseMessage>) => void)
  - - (value: BaseMessage, key: string, map: Map<string, BaseMessage>): void
    - Parameters
      
      value: BaseMessage
      
      key: string
      
      map: Map<string, BaseMessage>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from BaseManager.forEach
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key: string): BaseMessage
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: string
Returns BaseMessage
Inherited from BaseManager.get
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:34

has

has(key: string): boolean
Returns
boolean indicating whether an element with the specified key exists or not.
Parameters
- key: string
Returns boolean
Inherited from BaseManager.has
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

items

items(): BaseMessage[]
Returns BaseMessage[]
Inherited from BaseManager.items
- Defined in core/src/managers/BaseManager.ts:20

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from BaseManager.keys
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

map

map<U>(callbackfn: ((value: BaseMessage, index: number, array: BaseMessage[]) => U)): U[]
Type Parameters
- U
Parameters
- callbackfn: ((value: BaseMessage, index: number, array: BaseMessage[]) => U)
  - - (value: BaseMessage, index: number, array: BaseMessage[]): U
    - Parameters
      
      value: BaseMessage
      
      index: number
      
      array: BaseMessage[]
      
      Returns U
Returns U[]
Inherited from BaseManager.map
- Defined in core/src/managers/BaseManager.ts:30

offUpdate

offUpdate(callback: MiniEmitterCallback<BaseMessage>): MessageManager
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<BaseMessage>
  
  The callback to stop listening for updates on.
Returns MessageManager
Inherited from BaseManager.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:58

onUpdate

onUpdate(callback: MiniEmitterCallback<BaseMessage>): MessageManager
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<BaseMessage>
  
  The callback to run when an update occurs.
Returns MessageManager
Inherited from BaseManager.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:49

search

search(params: {
    after?: string;
    before?: string;
    include_users?: boolean;
    limit?: number;
    query: string;
    sort?: "Relevance" | "Latest" | "Oldest";
}): Promise<BaseMessage[]>
Parameters
- params: {
      after?: string;
      before?: string;
      include_users?: boolean;
      limit?: number;
      query: string;
      sort?: "Relevance" | "Latest" | "Oldest";
  }
  - Optional after?: string
    
    Description
    Message id after which messages should be fetched
  - Optional before?: string
    
    Description
    Message id before which messages should be fetched
  - Optional include_users?: boolean
    
    Description
    Whether to include user (and member, if server channel) objects
  - Optional limit?: number
    
    Format: int64
    
    Description
    Maximum number of messages to fetch
  - query: string
    
    Description
    Full-text search query
    
    See MongoDB documentation for more information.
  - Optional sort?: "Relevance" | "Latest" | "Oldest"
    
    Description
    Message sort direction
    
    By default, it will be sorted by latest.
    
    Default
    Relevance
Returns Promise<BaseMessage[]>
- Defined in core/src/managers/MessageManager.ts:61

set

set(key: string, value: BaseMessage): MessageManager
Parameters
- key: string
- value: BaseMessage
Returns MessageManager
Inherited from BaseManager.set
- Defined in core/src/managers/BaseManager.ts:9

sort

sort(...d: [compareFn?: ((a: BaseMessage, b: BaseMessage) => number)]): BaseMessage[]
Parameters
- Rest ...d: [compareFn?: ((a: BaseMessage, b: BaseMessage) => number)]
Returns BaseMessage[]
Inherited from BaseManager.sort
- Defined in core/src/managers/BaseManager.ts:33

values

values(): IterableIterator<BaseMessage>
Returns an iterable of values in the map

Returns IterableIterator<BaseMessage>
Inherited from BaseManager.values
- Defined in node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class MessageManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

channel: Channel

Returns MessageManager

Properties

Readonly [toStringTag]

channel

Private client

Readonly size

Returns

Static Readonly [species]

Accessors

ordered

Returns BaseMessage[]

Methods

[iterator]

Returns IterableIterator<[string, BaseMessage]>

bulkDelete

Parameters

ids: string[] | Message[]

Returns Promise<void>

clear

Returns void

construct

Parameters

_id: string

Description

Description

author: string

Description

channel: string

Description

Optional content?: string

Description

Optional edited?: string

Description

Description

Optional interactions?: { reactions?: string[]; restrict_reactions?: boolean; }

Description

Optional reactions?: string[]

Description

Optional restrict_reactions?: boolean

Description

Optional masquerade?: { avatar?: string; colour?: string; name?: string; }

Description

Optional avatar?: string

Description

Optional colour?: string

Description

Optional name?: string

Description

Optional mentions?: string[]

Description

Optional nonce?: string

Description

Optional reactions?: { [key: string]: string[]; }

Description

[key: string]: string[]

Optional replies?: string[]

Description

Description

Optional webhook?: { avatar?: string; name: string; }

Description

Optional avatar?: string

name: string

Returns BaseMessage

delete

Parameters

key: string

Returns boolean

entries

`Readonly` [toStringTag]

`Private` client

`Readonly` size

`Static` `Readonly` [species]

`Optional` content?: string

`Optional` edited?: string

`Optional` interactions?: {
reactions?: string[];
restrict_reactions?: boolean;
}

`Optional` reactions?: string[]

`Optional` restrict_reactions?: boolean

`Optional` masquerade?: {
avatar?: string;
colour?: string;
name?: string;
}

`Optional` avatar?: string

`Optional` colour?: string

`Optional` name?: string

`Optional` mentions?: string[]

`Optional` nonce?: string

`Optional` reactions?: {
[key: string]: string[];
}

`Optional` replies?: string[]

`Optional` webhook?: {
avatar?: string;
name: string;
}

`Optional` avatar?: string

`Optional` params: {
after?: string;
before?: string;
include_users?: boolean;
limit?: number;
nearby?: string;
sort?: "Relevance" | "Latest" | "Oldest";
}

`Optional` after?: string

`Optional` before?: string

`Optional` include_users?: boolean

`Optional` limit?: number

`Optional` nearby?: string

`Optional` sort?: "Relevance" | "Latest" | "Oldest"

`Rest` ...d: [predicate: ((value: BaseMessage, index: number, array: BaseMessage[]) => unknown), thisArg?: any]

`Rest` ...d: [predicate: ((value: BaseMessage, index: number, obj: BaseMessage[]) => unknown), thisArg?: any]

`Optional` updated: BaseMessage[]

`Optional` thisArg: any