diff --git a/Filters.md b/Filters.md new file mode 100644 index 0000000..3b50f0a --- /dev/null +++ b/Filters.md @@ -0,0 +1,37 @@ +# Not yet released + +# Date Filters +The exporter currently supports three date filters, namely, between, before, and after. All date filters are inclusive. + +## Format +The option takes keywords to identify the type and therefore the format must be followed: + +* Between filter keyword: ` - `, and the format is ` - ` +* Before filter keyword: `< `, and the format is `< ` +* After filter keyword: `> `, and the format is `> ` + +## Date Format +The default date format is `%Y-%m-%d %H:%M`. You can change it with the `--range-format` option. The value should be a formatting string supported by `strftime` and `strptime` functions. + +For example, if you want to supply an ISO compliant date: `wtsexporter -a --range "< 2024-01-01T00:00:00.00000Z" --range-format "%Y-%m-%dT%H:%M:%S.%fZ"` + +## Example +### Between +This will export messages received or sent between 2023-01-01 00:00 to 2024-01-01 00:00, inclusively. +``` +wtsexporter.exe -a --range "2023-01-01 00:00 - 2024-01-01 00:00" +``` + +### Before +This will only export messages received or sent before 2024-01-01 00:00. +``` +wtsexporter.exe -a --range "< 2024-01-01 00:00" +``` + +### After +This will only export messages received or sent after 2023-01-01 00:00. +``` +wtsexporter.exe -a --range "> 2023-01-01 00:00" +``` + +# Chat Filter