Add documentation for delayed event options

This commit is contained in:
Andrew Ferrazzutti committed 2026-10-16 00:02:10 -04:00
1 parent 4785f06e0e
commit 5cf5339f4e
2 files changed
+57

No files matched your search

@@ -856,6 +856,30 @@ Example configuration:
max_event_delay_duration: 24h
```
---
### `delayed_events`
*(object)* Options for delayed events, as per [MSC4140](https://github.com/matrix-org/matrix-spec-proposals/pull/4140).
This setting has the following sub-options:
* `max_delayed_events_per_user` (integer): The maximum number of delayed events a user may have scheduled at a time. Must be a non-negative integer. If 0, sending of delayed events is disallowed. Defaults to `100`.
* `finalised_retention_period` (duration): How long a delayed event is retained for lookup after it has been finalised, i.e. sent, cancelled, or failed to be sent. Must be a non-negative duration. If 0, finalised delayed events are not retained.
Finalised delayed events past their retention are pruned every 5 minutes.
Defaults to `"7d"`.
* `finalised_retention_limit_per_user` (integer): The maximum number of finalised delayed events retained per user, keeping the most recently finalised ones. Must be a non-negative integer. If 0, finalised delayed events are not retained. Defaults to `1000`.
Example configuration:
```yaml
delayed_events:
max_delayed_events_per_user: 100
finalised_retention_period: 7d
finalised_retention_limit_per_user: 1000
```
---
### `user_types`
*(object)* Configuration settings related to the user types feature.
+33
View File
@@ -1059,6 +1059,39 @@ properties:
default: null
examples:
- 24h
delayed_events:
type: object
description: >-
Options for delayed events, as per
[MSC4140](https://github.com/matrix-org/matrix-spec-proposals/pull/4140).
properties:
max_delayed_events_per_user:
type: integer
description: >-
The maximum number of delayed events a user may have scheduled at a time.
Must be a non-negative integer. If 0, sending of delayed events is disallowed.
default: 100
finalised_retention_period:
$ref: "#/$defs/duration"
description: >-
How long a delayed event is retained for lookup after it has been finalised,
i.e. sent, cancelled, or failed to be sent. Must be a non-negative duration.
If 0, finalised delayed events are not retained.
Finalised delayed events past their retention are pruned every 5 minutes.
default: 7d
finalised_retention_limit_per_user:
type: integer
description: >-
The maximum number of finalised delayed events retained per user, keeping
the most recently finalised ones. Must be a non-negative integer.
If 0, finalised delayed events are not retained.
default: 1000
examples:
- max_delayed_events_per_user: 100
finalised_retention_period: 7d
finalised_retention_limit_per_user: 1000
user_types:
type: object
description: >-