Skip to content
This repository has been archived by the owner on Mar 22, 2023. It is now read-only.

How to use Filter

tangyoha edited this page Feb 12, 2023 · 1 revision

author: [email protected] last edit: 2023/2/12

You can use filters to filter messages you don't want to download very easily

Support Type

  • date_time_str - Support using ./- to split year, month, and day.Supports 4 precision time formats.
    • 2013.8.15 22:46:21 (eq 2013.8.15 22:46:21)
    • 2013.8.15 22:46 (eq 2013.8.15 22:46:00)
    • 2013.8.15 (eq 2013.8.15 00:00:00)
    • 2014.8 (eq 2014.8.1 00:00:00)
  • str - String supports two matching formats
    • simple string comparison
      • message_caption == '123'
    • regular expression match
      • message_caption == r'123.*'
  • int
    • message_id >= 1024

Support Operator

type operator
date_time_str > < >= <= != ==
str != ==
int > < >= <= != ==

Support Meta Data

meta data name type
message_date date_time_str
message_id int
message_caption str
media_file_size int
media_width int
media_height int
media_file_name str
media_duration int

Example

  • message_date_time : - Date the message was sent(date_time_str)
    • like: message_date_time > 2022.03.04 && message_date_time < 2022.03.08
    • like: message_date_time > 2022-03-04 14:50 && message_date_time < 2022.03.08
    • like: message_date_time > 2022-03 && message_date_time < 2022-04
    • like: message_date_time > 2022-03 and message_date_time < 2022-04
    • like: message_date_time >= 2022-03
    • like: message_date_time <= 2022-03
  • message_id : - Message 's id(int)
    • like: message_id >= 20001 && message_id <=20100
    • like: message_id >= 20001 and message_id <=20100
  • media_file_size : - File size(int)
    • like: media_file_size >= 10 * 1024 * 1024 && media_file_size <= 1024 * 1024 * 1024
  • media_width : - Include photo and video(int)
    • like: media_width >= 1920 and media_height >= 1080
  • media_height : - Include photo and video(int)
  • media_duration: - Media duration(int)
  • media_file_name : - file name(str)
    • like: media_file_name == 'test.mp4'(str equal)
    • like: media_file_name == r'test.*mp4'(with r prefix)
    • like: media_file_name == r'.*test.*'(with r prefix)
  • message_caption : - message caption(tpye: str)
    • like: message_caption == '#v2'(str equal)
    • like: message_caption == r'.*#v2.*'(with r prefix)
    • like: message_caption != r'.*#v2.*'(with r prefix)
Clone this wiki locally