Function iterSearchMessages

Parameters

• client: ITelegramClient
• Optionalparams: {
      addOffset?: number;
      chatId?: InputPeerLike;
      filter?: TypeMessagesFilter;
      fromUser?: InputPeerLike;
      limit?: number;
      maxDate?: number | Date;
      maxId?: number;
      minDate?: number | Date;
      minId?: number;
      offset?: number;
      query?: string;
      threadId?: number;
  } & { chunkSize?: number; limit?: number }

  Additional search parameters

  • OptionaladdOffset?: number

    Additional offset from offset, in resulting messages.

    This can be used for advanced use cases, like:

    • Loading 20 results newer than message with ID MSGID: offset = MSGID, addOffset = -20, limit = 20
    • Loading 20 results around message with ID MSGID: offset = MSGID, addOffset = -10, limit = 20

    When offset is not set, this will be relative to the last message

    Default

    0 (disabled)

  • OptionalchatId?: InputPeerLike

    Chat where to search for messages.

    When empty, will search across common message box (i.e. private messages and legacy chats)

  • Optionalfilter?: TypeMessagesFilter

    Filter the results using some filter (see SearchFilters)

    Default

    SearchFilters.Empty (i.e. will return all messages)

  • OptionalfromUser?: InputPeerLike

    Search only for messages sent by a specific user.

    You can pass their marked ID, username, phone or "me" or "self"

  • Optionallimit?: number

    Limits the number of messages to be retrieved.

    Default

    100
    Copy

  • OptionalmaxDate?: number | Date

    Maximum message date to return

    Default

    0 (disabled).

  • OptionalmaxId?: number

    Maximum message ID to return.

    Unless addOffset is used, this will work the same as offset.

    Default

    0 (disabled).

  • OptionalminDate?: number | Date

    Minimum message date to return

    Default

    0 (disabled).

  • OptionalminId?: number

    Minimum message ID to return

    Default

    0 (disabled).

  • Optionaloffset?: number

    Offset ID for the search. Only messages earlier than this ID will be returned.

    Default

    0 (starting from the latest message).

  • Optionalquery?: string

    Text query string. Required for text-only messages, optional for media.

    Default

    "" (empty string)

  • OptionalthreadId?: number

    Thread ID to return only messages from this thread.

  • OptionalchunkSize?: number

    Chunk size, which will be passed as limit parameter for messages.search. Usually you shouldn't care about this.

    Default

    100

  • Optionallimit?: number

    Limits the number of messages to be retrieved.

    Default

    Infinity, i.e. all messages are returned