Class ChatManager

Hierarchy (View Summary)

Constructors

constructor

Properties

cache cacheFilter? cacheSize

Accessors

client

Methods

_add [iterator] fetch remove resolve resolveId

Constructors

constructor

Properties

Readonlycache

cache: Collection<string, Chat>

Optional ReadonlycacheFilter

cacheFilter?: (holds: Chat) => boolean

ReadonlycacheSize

cacheSize: number

Accessors

client

Methods

_add

  • _add(
        data: Chat,
        cache?: boolean,
        __namedParameters?: { extras?: unknown[]; id?: string },
    ): 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 }

    Returns Chat

    The cached or newly created entry.

[iterator]

  • "[iterator]"(): IterableIterator<[string, Chat], any, any>

  • Returns a new Iterator object that contains the [key, value] pairs for each element in the collection.

    Returns IterableIterator<[string, Chat], any, any>

    An iterator object that can be used to iterate over the key-value pairs of the Collection.

fetch

  • fetch(
        user: string | Chat,
        options?: Omit<IFetchOptions, "fullInfo"> & { fullInfo?: false },
    ): 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: string | Chat,
        options?: Omit<IFetchOptions, "fullInfo"> & { fullInfo: true },
    ): 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: string | Chat,
        options?: IFetchOptions,
    ): Promise<ChatFullInfo | Chat>

  • Fetches a chat object from the API.

    Parameters

    Returns Promise<ChatFullInfo | Chat>

    The fetched chat or full chat info object.

remove

  • remove(id: string): 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.

resolve

resolveId

  • resolveId(idOrInstance: any): 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.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods