Function iterChatEventLog

Parameters

• client: ITelegramClient
• chatId: InputPeerLike

  Chat ID

• Optionalparams: {
      filters?: InputChatEventFilters;
      limit?: number;
      maxId?: Long;
      minId?: Long;
      query?: string;
      users?: InputPeerLike[];
  } & { chunkSize?: number; limit?: number }

  • Optionalfilters?: InputChatEventFilters

    Event filters. Can be a TL object, or one or more action types.

    Note that some filters are grouped in TL (i.e. info=true will return title_changed, username_changed and many more), and when passing one or more action types, they will be filtered locally.

  • Optionallimit?: number

    Limit the number of events returned.

    Note: when using filters, there will likely be less events returned than specified here. This limit is only used to limit the number of events to fetch from the server.

    If you need to limit the number of events returned, use iterChatEventLog instead.

    Default

    100
    Copy

  • OptionalmaxId?: Long

    Maximum event ID to return, can be used as a base offset

  • OptionalminId?: Long

    Minimum event ID to return

  • Optionalquery?: string

    Search query

  • Optionalusers?: InputPeerLike[]

    List of users whose actions to return

  • OptionalchunkSize?: number

    Chunk size, passed as limit to getChatEventLog. Usually you don't need to touch this.

    Default

    100
    Copy

  • Optionallimit?: number

    Total number of events to return.

    Default

    Infinity
    Copy