Class ChatManager

Hierarchy (view full)

BaseManager<Chat, ApiChat>
- ChatManager

Index

Constructors

Properties

cache cacheFilter? cacheSize

Accessors

Methods

[iterator] _add fetch remove resolve resolveId

Constructors

constructor

new ChatManager(client, iterable, options?): ChatManager
Parameters
- client: TelegramClient | BaseClient
  The client instance.
- iterable: Chat[]
  Data iterable.
- Optionaloptions: ICachedOptions<Chat>
  Options for save cached.
Returns ChatManager
Overrides BaseManager.constructor

Properties

`Readonly`cache

cache: Collection<string, Chat>

`Optional` `Readonly`cacheFilter

cacheFilter?: ((holds: Chat) => boolean)

`Readonly`cacheSize

cacheSize: number

Accessors

client

get client(): TelegramClient | BaseClient
The client that instantiated this

Returns TelegramClient | BaseClient
Inherited from BaseManager.client

Methods

[iterator]

[iterator](): IterableIterator<[string, Chat]>
Returns a new Iterator object that contains the [key, value] pairs for each element in the collection.

Returns IterableIterator<[string, Chat]>
An iterator object that can be used to iterate over the key-value pairs of the Collection.

Inherited from BaseManager.[iterator]

_add

_add(data, cache?, __namedParameters?): Chat
Adds or updates an entry in the cache.
Parameters
- data: Chat
  The data to be added or updated in the cache.
- Optionalcache: boolean
- Optional__namedParameters: {
  extras?: unknown[];
  id?: string;
  }
  - Optionalextras?: unknown[]
  - Optionalid?: string
Returns Chat
The cached or newly created entry.

Inherited from BaseManager._add

fetch

fetch(user, options?): Promise<Chat>
Fetches a chat object from the API.
Parameters
- user: string | Chat
- Optionaloptions: Omit<IFetchOptions, "fullInfo"> & {
  fullInfo?: false;
  }
  Additional options.
Returns Promise<Chat>
The fetched chat object.
fetch(user, options?): Promise<ChatFullInfo>
Fetches a chat object from the API.
Parameters
- user: string | Chat
- Optionaloptions: Omit<IFetchOptions, "fullInfo"> & {
  fullInfo: true;
  }
  Additional options.
Returns Promise<ChatFullInfo>
The fetched ChatFullInfo object.
fetch(user, options?): Promise<ChatFullInfo | Chat>
Fetches a chat object from the API.
Parameters
- user: string | Chat
- Optionaloptions: IFetchOptions
  Additional options.
Returns Promise<ChatFullInfo | Chat>
The fetched chat or full chat info object.

remove

remove(id): boolean
Removes an entry from the cache.
Parameters
- id: string
  The ID of the entry to remove.
Returns boolean
Whether the entry was successfully removed.

Inherited from BaseManager.remove

resolve

resolve(chat): null | Chat
Resolves a chat object.
Parameters
- chat:
      | string
      | Message
      | ChatMember
      | Chat
  The chat instance, chat member, message, or ID.
Returns null | Chat
- The resolved chat object or null if not found.
Overrides BaseManager.resolve

resolveId

resolveId(idOrInstance): null | string
Resolves the ID of an entry from the cache.
Parameters
- idOrInstance: any
  The ID or instance to resolve.
Returns null | string
The resolved ID or null if not found.

Inherited from BaseManager.resolveId