Function iterSearchGlobal

Parameters

• client: ITelegramClient
• Optionalparams: {
      filter?: TypeMessagesFilter;
      limit?: number;
      maxDate?: number | Date;
      minDate?: number | Date;
      offset?: SearchGlobalOffset;
      onlyChannels?: boolean;
      query?: string;
  } & { chunkSize?: number; limit?: number }

  Search parameters

  • Optionalfilter?: TypeMessagesFilter

    Filter the results using some filter. (see SearchFilters)

    Default

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

  • Optionallimit?: number

    Limits the number of messages to be retrieved.

    Default

    100
    Copy

  • OptionalmaxDate?: number | Date

    Only return messages older than this date

  • OptionalminDate?: number | Date

    Only return messages newer than this date

  • Optionaloffset?: SearchGlobalOffset

    Offset data used for pagination

  • OptionalonlyChannels?: boolean

    Whether to only search across broadcast channels

  • Optionalquery?: string

    Text query string. Use "@" to search for mentions.

    Default

    "" (empty string)

  • OptionalchunkSize?: number

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

    Default

    100
    Copy

  • Optionallimit?: number

    Limits the number of messages to be retrieved.

    Default

    Infinity, i.e. all messages are returned