mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-05-01 14:44:09 +02:00
Compare commits
5 commits
a7e0c3fdef
...
f036cc1b6f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f036cc1b6f | ||
|
|
d968774fb7 | ||
|
|
2aacc1feda | ||
|
|
2a8c0bc7b8 | ||
|
|
81a864545f |
|
|
@ -1 +0,0 @@
|
||||||
Room IDs can now appear without a domain component in [room version 12](/rooms/v12), as per [MSC4291](https://github.com/matrix-org/matrix-spec-proposals/pull/4291).
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Fix JSON formatting in the "Server admin style permissions" examples.
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Deprecate `m.set_avatar_url` and `m.set_displayname` capabilities, as per [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Update user profile endpoints to handle custom fields, and add a new `m.profile_fields` capability, as per [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Clarify that `format` is required if `formatted_body` is specified.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
The `latest_event` in an aggregated set of thread events uses the same format as the event itself.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Fix various typos throughout the specification.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add `format` query parameter to `GET /state/{eventType}/{stateKey}` to allow fetching metadata of a specific state event.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Fix various typos throughout the specification.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Fix various typos throughout the specification.
|
|
||||||
1
changelogs/client_server/newsfragments/2186.removal
Normal file
1
changelogs/client_server/newsfragments/2186.removal
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Remove legacy mentions, as per [MSC4210](https://github.com/matrix-org/matrix-spec-proposals/issues/4210).
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add the `use_state_after` query parameter and `state_after` response property to `GET /sync`, as per [MSC4222](https://github.com/matrix-org/matrix-spec-proposals/issues/4222).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Clarify that clients should replace events with the most recent replacement by `origin_server_ts`.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
When upgrading rooms to [room version 12](/rooms/v12), `additional_creators` may be specified on the [`POST /_matrix/client/v3/rooms/{roomId}/upgrade`](/client-server-api/#post_matrixclientv3roomsroomidupgrade) endpoint, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
When creating rooms with [room version 12](/rooms/v12), the `trusted_private_chat` preset should merge the invitees into the supplied `content.additional_creators` in the resulting room, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
In [room version 12](/rooms/v12), the power level of room creators is now infinitely high as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
In [room version 12](/rooms/v12), room IDs no longer have a domain component as per [MSC4291](https://github.com/matrix-org/matrix-spec-proposals/pull/4291).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
When creating rooms with [room version 12](/rooms/v12), the initial power levels will restrict the ability to upgrade rooms by default, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Fix `/sync` flow referencing incorrect parameter to use with `/messages`.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Clarify wording around the `world_readable` history visibility setting. Contributed by @HarHarLinks.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add a profile field for a user's time zone, as per [MSC4175](https://github.com/matrix-org/matrix-spec-proposals/pull/4175).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Invites and knocks are now expected to contain the `m.room.create` event in their stripped state entries, as per [MSC4311](https://github.com/matrix-org/matrix-spec-proposals/pull/4311).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Remove unintentional intentional mentions in replies, as per [MSC4142](https://github.com/matrix-org/matrix-spec-proposals/pull/4142).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Declare the Application Service Registration schema to follow JSON Schema spec 2020-12.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Declare the event schemas to follow JSON Schema spec 2020-12.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add "placeholder MSC" process definition.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Upgrade the docsy theme to version 0.12.0.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
GitHub actions are now building the OpenAPI `spec/identity-service-api/api.json` file.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Minor fixes to JSON schemas.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Specify a correct spelling for "display name".
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Fix a grammatical typo on the Matrix Spec Process documentation page.
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
In room versions 1 through 12, an event's `auth_events` have always needed to belong to the same room as per [MSC4307](https://github.com/matrix-org/matrix-spec-proposals/pull/4307).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add [room version 12](/rooms/v12) as per [MSC4304](https://github.com/matrix-org/matrix-spec-proposals/pull/4304).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Room IDs in room version 12 are now the event ID of the create event with the normal room ID sigil (`!`), as per [MSC4291](https://github.com/matrix-org/matrix-spec-proposals/pull/4291).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Room creators are formalized in room version 12 and have infinitely high power level, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
State Resolution is updated in room version 12 to reduce the opportunity for "state resets", as per [MSC4297](https://github.com/matrix-org/matrix-spec-proposals/pull/4297).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
The default room version is now room version 12, though servers SHOULD keep using room version 11 for a little while, as per [MSC4304](https://github.com/matrix-org/matrix-spec-proposals/pull/4304).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Add [room version 12](/rooms/v12) as per [MSC4304](https://github.com/matrix-org/matrix-spec-proposals/pull/4304).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
`invite_room_state` and `knock_room_state` now have additional requirements and validation depending on the room version, as per [MSC4311](https://github.com/matrix-org/matrix-spec-proposals/pull/4311).
|
|
||||||
|
|
@ -67,7 +67,7 @@ current_version_url = "https://spec.matrix.org/latest"
|
||||||
# The following is used when status = "stable", and is displayed in various UI elements on a released version
|
# The following is used when status = "stable", and is displayed in various UI elements on a released version
|
||||||
# of the spec.
|
# of the spec.
|
||||||
# major = "1"
|
# major = "1"
|
||||||
# minor = "15"
|
# minor = "16"
|
||||||
|
|
||||||
# User interface configuration
|
# User interface configuration
|
||||||
[params.ui]
|
[params.ui]
|
||||||
|
|
|
||||||
|
|
@ -438,8 +438,8 @@ user ID without a password.
|
||||||
|
|
||||||
Content:
|
Content:
|
||||||
{
|
{
|
||||||
type: "m.login.application_service",
|
"type": "m.login.application_service",
|
||||||
username: "_irc_example"
|
"username": "_irc_example"
|
||||||
}
|
}
|
||||||
|
|
||||||
Similarly, logging in as users needs API changes in order to allow the AS to
|
Similarly, logging in as users needs API changes in order to allow the AS to
|
||||||
|
|
@ -454,7 +454,7 @@ log in without needing the user's password. This is achieved by including the
|
||||||
|
|
||||||
Content:
|
Content:
|
||||||
{
|
{
|
||||||
type: "m.login.application_service",
|
"type": "m.login.application_service",
|
||||||
"identifier": {
|
"identifier": {
|
||||||
"type": "m.id.user",
|
"type": "m.id.user",
|
||||||
"user": "_irc_example"
|
"user": "_irc_example"
|
||||||
|
|
|
||||||
103
content/changelog/v1.16.md
Normal file
103
content/changelog/v1.16.md
Normal file
|
|
@ -0,0 +1,103 @@
|
||||||
|
---
|
||||||
|
title: v1.16 Changelog
|
||||||
|
linkTitle: v1.16
|
||||||
|
type: docs
|
||||||
|
layout: changelog
|
||||||
|
outputs:
|
||||||
|
- html
|
||||||
|
- checklist
|
||||||
|
date: 2025-09-17
|
||||||
|
---
|
||||||
|
|
||||||
|
## Client-Server API
|
||||||
|
|
||||||
|
**Deprecations**
|
||||||
|
|
||||||
|
- Deprecate `m.set_avatar_url` and `m.set_displayname` capabilities, as per [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133). ([#2071](https://github.com/matrix-org/matrix-spec/issues/2071))
|
||||||
|
|
||||||
|
**Removed Endpoints**
|
||||||
|
|
||||||
|
- Remove unintentional intentional mentions in replies, as per [MSC4142](https://github.com/matrix-org/matrix-spec-proposals/pull/4142). ([#2210](https://github.com/matrix-org/matrix-spec/issues/2210))
|
||||||
|
|
||||||
|
**Backwards Compatible Changes**
|
||||||
|
|
||||||
|
- Update user profile endpoints to handle custom fields, and add a new `m.profile_fields` capability, as per [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133). ([#2071](https://github.com/matrix-org/matrix-spec/issues/2071))
|
||||||
|
- Add `format` query parameter to `GET /state/{eventType}/{stateKey}` to allow fetching metadata of a specific state event. ([#2175](https://github.com/matrix-org/matrix-spec/issues/2175))
|
||||||
|
- Add the `use_state_after` query parameter and `state_after` response property to `GET /sync`, as per [MSC4222](https://github.com/matrix-org/matrix-spec-proposals/issues/4222). ([#2187](https://github.com/matrix-org/matrix-spec/issues/2187))
|
||||||
|
- When upgrading rooms to [room version 12](/rooms/v12), `additional_creators` may be specified on the [`POST /_matrix/client/v3/rooms/{roomId}/upgrade`](/client-server-api/#post_matrixclientv3roomsroomidupgrade) endpoint, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- When creating rooms with [room version 12](/rooms/v12), the `trusted_private_chat` preset should merge the invitees into the supplied `content.additional_creators` in the resulting room, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- In [room version 12](/rooms/v12), the power level of room creators is now infinitely high as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- In [room version 12](/rooms/v12), room IDs no longer have a domain component as per [MSC4291](https://github.com/matrix-org/matrix-spec-proposals/pull/4291). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- When creating rooms with [room version 12](/rooms/v12), the initial power levels will restrict the ability to upgrade rooms by default, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- Add a profile field for a user's time zone, as per [MSC4175](https://github.com/matrix-org/matrix-spec-proposals/pull/4175). ([#2206](https://github.com/matrix-org/matrix-spec/issues/2206))
|
||||||
|
- Invites and knocks are now expected to contain the `m.room.create` event in their stripped state entries, as per [MSC4311](https://github.com/matrix-org/matrix-spec-proposals/pull/4311). ([#2207](https://github.com/matrix-org/matrix-spec/issues/2207))
|
||||||
|
|
||||||
|
**Spec Clarifications**
|
||||||
|
|
||||||
|
- Clarify that `format` is required if `formatted_body` is specified. ([#2167](https://github.com/matrix-org/matrix-spec/issues/2167))
|
||||||
|
- The `latest_event` in an aggregated set of thread events uses the same format as the event itself. ([#2169](https://github.com/matrix-org/matrix-spec/issues/2169))
|
||||||
|
- Fix various typos throughout the specification. ([#2171](https://github.com/matrix-org/matrix-spec/issues/2171), [#2177](https://github.com/matrix-org/matrix-spec/issues/2177), [#2179](https://github.com/matrix-org/matrix-spec/issues/2179))
|
||||||
|
- Clarify that clients should replace events with the most recent replacement by `origin_server_ts`. ([#2190](https://github.com/matrix-org/matrix-spec/issues/2190))
|
||||||
|
- Fix `/sync` flow referencing incorrect parameter to use with `/messages`. ([#2195](https://github.com/matrix-org/matrix-spec/issues/2195))
|
||||||
|
- Clarify wording around the `world_readable` history visibility setting. Contributed by @HarHarLinks. ([#2204](https://github.com/matrix-org/matrix-spec/issues/2204))
|
||||||
|
|
||||||
|
|
||||||
|
## Server-Server API
|
||||||
|
|
||||||
|
**Backwards Compatible Changes**
|
||||||
|
|
||||||
|
- `invite_room_state` and `knock_room_state` now have additional requirements and validation depending on the room version, as per [MSC4311](https://github.com/matrix-org/matrix-spec-proposals/pull/4311). ([#2207](https://github.com/matrix-org/matrix-spec/issues/2207))
|
||||||
|
|
||||||
|
|
||||||
|
## Application Service API
|
||||||
|
|
||||||
|
No significant changes.
|
||||||
|
|
||||||
|
|
||||||
|
## Identity Service API
|
||||||
|
|
||||||
|
No significant changes.
|
||||||
|
|
||||||
|
|
||||||
|
## Push Gateway API
|
||||||
|
|
||||||
|
No significant changes.
|
||||||
|
|
||||||
|
|
||||||
|
## Room Versions
|
||||||
|
|
||||||
|
**Backwards Compatible Changes**
|
||||||
|
|
||||||
|
- Room IDs in room version 12 are now the event ID of the create event with the normal room ID sigil (`!`), as per [MSC4291](https://github.com/matrix-org/matrix-spec-proposals/pull/4291). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- Room creators are formalized in room version 12 and have infinitely high power level, as per [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- State Resolution is updated in room version 12 to reduce the opportunity for "state resets", as per [MSC4297](https://github.com/matrix-org/matrix-spec-proposals/pull/4297). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- The default room version is now room version 12, though servers SHOULD keep using room version 11 for a little while, as per [MSC4304](https://github.com/matrix-org/matrix-spec-proposals/pull/4304). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
- Add [room version 12](/rooms/v12) as per [MSC4304](https://github.com/matrix-org/matrix-spec-proposals/pull/4304). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193), [#2199](https://github.com/matrix-org/matrix-spec/issues/2199))
|
||||||
|
|
||||||
|
**Spec Clarifications**
|
||||||
|
|
||||||
|
- In room versions 1 through 12, an event's `auth_events` have always needed to belong to the same room as per [MSC4307](https://github.com/matrix-org/matrix-spec-proposals/pull/4307). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
|
||||||
|
|
||||||
|
## Appendices
|
||||||
|
|
||||||
|
**Backwards Compatible Changes**
|
||||||
|
|
||||||
|
- Room IDs can now appear without a domain component in [room version 12](/rooms/v12), as per [MSC4291](https://github.com/matrix-org/matrix-spec-proposals/pull/4291). ([#2193](https://github.com/matrix-org/matrix-spec/issues/2193))
|
||||||
|
|
||||||
|
|
||||||
|
## Internal Changes/Tooling
|
||||||
|
|
||||||
|
**Backwards Compatible Changes**
|
||||||
|
|
||||||
|
- Add "placeholder MSC" process definition. ([#2157](https://github.com/matrix-org/matrix-spec/issues/2157))
|
||||||
|
|
||||||
|
**Spec Clarifications**
|
||||||
|
|
||||||
|
- Declare the Application Service Registration schema to follow JSON Schema spec 2020-12. ([#2132](https://github.com/matrix-org/matrix-spec/issues/2132))
|
||||||
|
- Declare the event schemas to follow JSON Schema spec 2020-12. ([#2132](https://github.com/matrix-org/matrix-spec/issues/2132))
|
||||||
|
- Upgrade the docsy theme to version 0.12.0. ([#2160](https://github.com/matrix-org/matrix-spec/issues/2160))
|
||||||
|
- GitHub actions are now building the OpenAPI `spec/identity-service-api/api.json` file. ([#2172](https://github.com/matrix-org/matrix-spec/issues/2172))
|
||||||
|
- Minor fixes to JSON schemas. ([#2182](https://github.com/matrix-org/matrix-spec/issues/2182))
|
||||||
|
- Specify a correct spelling for "display name". ([#2189](https://github.com/matrix-org/matrix-spec/issues/2189))
|
||||||
|
- Fix a grammatical typo on the Matrix Spec Process documentation page. ([#2205](https://github.com/matrix-org/matrix-spec/issues/2205))
|
||||||
|
|
@ -3,6 +3,9 @@
|
||||||
|
|
||||||
{{% changed-in v="1.7" %}}
|
{{% changed-in v="1.7" %}}
|
||||||
|
|
||||||
|
{{% changed-in v="1.17" %}}: the legacy push rules that looked for mentions in
|
||||||
|
the `body` of the event were removed.
|
||||||
|
|
||||||
This module allows users to "mention" other users and rooms within a room event.
|
This module allows users to "mention" other users and rooms within a room event.
|
||||||
This is primarily used as an indicator that the recipient should receive a notification
|
This is primarily used as an indicator that the recipient should receive a notification
|
||||||
about the event.
|
about the event.
|
||||||
|
|
@ -38,19 +41,18 @@ encrypted as normal. To properly process mentions in encrypted rooms, events
|
||||||
must be decrypted first. See [receiving notifications](#receiving-notifications).
|
must be decrypted first. See [receiving notifications](#receiving-notifications).
|
||||||
{{% /boxes/warning %}}
|
{{% /boxes/warning %}}
|
||||||
|
|
||||||
Note that, for backwards compatibility, push rules such as [`.m.rule.contains_display_name`](#_m_rule_contains_display_name),
|
{{% boxes/note %}}
|
||||||
[`.m.rule.contains_user_name`](#_m_rule_contains_user_name), and
|
|
||||||
[`.m.rule.roomnotif`](#_m_rule_roomnotif) continue to match if the `body` of
|
|
||||||
the event contains the user's display name or ID. To avoid unintentional notifications,
|
|
||||||
**it is recommended that clients include a `m.mentions` property on each event**.
|
|
||||||
(If there are no mentions to include it can be an empty object.)
|
|
||||||
|
|
||||||
{{% boxes/rationale %}}
|
|
||||||
In previous versions of the specification, mentioning users was done by
|
In previous versions of the specification, mentioning users was done by
|
||||||
including the user's display name or the localpart of their Matrix ID and room
|
including the user's display name or the localpart of their Matrix ID and room
|
||||||
mentions were done by including the string "@room" in the plaintext `body` of
|
mentions were done by including the string "@room" in the plaintext `body` of
|
||||||
the event. This was prone to confusing and buggy behaviour.
|
the event. When the `m.mentions` field was introduced, those push rules were
|
||||||
{{% /boxes/rationale %}}
|
disabled if the `m.mentions` field was present.
|
||||||
|
|
||||||
|
To avoid unintentional notifications with clients and servers that still use
|
||||||
|
those push rules, **it is recommended that clients still include a `m.mentions`
|
||||||
|
property on each event**. (If there are no mentions to include it can be an
|
||||||
|
empty object.)
|
||||||
|
{{% /boxes/note %}}
|
||||||
|
|
||||||
#### Client behaviour
|
#### Client behaviour
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -382,6 +382,9 @@ The following `alt_aliases` values will NOT match:
|
||||||
|
|
||||||
**`contains_display_name`**
|
**`contains_display_name`**
|
||||||
|
|
||||||
|
{{% changed-in v="1.17" %}}: this condition is deprecated and **should not be
|
||||||
|
used in new push rules**.
|
||||||
|
|
||||||
This matches messages where `content.body` contains the owner's display name in
|
This matches messages where `content.body` contains the owner's display name in
|
||||||
that room. This is a separate condition because display names may change and as such
|
that room. This is a separate condition because display names may change and as such
|
||||||
it would be hard to maintain a rule that matched the user's display name. This
|
it would be hard to maintain a rule that matched the user's display name. This
|
||||||
|
|
@ -413,6 +416,9 @@ Parameters:
|
||||||
|
|
||||||
#### Predefined Rules
|
#### Predefined Rules
|
||||||
|
|
||||||
|
{{% changed-in v="1.17" %}}: the legacy default push rules that looked for
|
||||||
|
mentions in the `body` of the event were removed.
|
||||||
|
|
||||||
Homeservers can specify "server-default rules". They operate at a lower
|
Homeservers can specify "server-default rules". They operate at a lower
|
||||||
priority than "user-defined rules", except for the `.m.rule.master` rule
|
priority than "user-defined rules", except for the `.m.rule.master` rule
|
||||||
which has always a higher priority than any other rule. The `rule_id`
|
which has always a higher priority than any other rule. The `rule_id`
|
||||||
|
|
@ -557,41 +563,6 @@ Definition:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<a id="_m_rule_contains_display_name"></a> **`.m.rule.contains_display_name`**
|
|
||||||
|
|
||||||
{{% changed-in v="1.7" %}}
|
|
||||||
|
|
||||||
As of `v1.7`, this rule is deprecated and **should only be enabled if the event
|
|
||||||
does not have an [`m.mentions` property](#definition-mmentions)**.
|
|
||||||
|
|
||||||
Matches any message whose content contains the user's current display name
|
|
||||||
in the room in which it was sent.
|
|
||||||
|
|
||||||
Definition:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"rule_id": ".m.rule.contains_display_name",
|
|
||||||
"default": true,
|
|
||||||
"enabled": true,
|
|
||||||
"conditions": [
|
|
||||||
{
|
|
||||||
"kind": "contains_display_name"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"actions": [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
"set_tweak": "sound",
|
|
||||||
"value": "default"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"set_tweak": "highlight"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
<a id="_m_rule_is_room_mention"></a> **`.m.rule.is_room_mention`**
|
<a id="_m_rule_is_room_mention"></a> **`.m.rule.is_room_mention`**
|
||||||
|
|
||||||
{{% added-in v="1.7" %}}
|
{{% added-in v="1.7" %}}
|
||||||
|
|
@ -626,44 +597,6 @@ Definition:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<a id="_m_rule_roomnotif"></a> **`.m.rule.roomnotif`**
|
|
||||||
|
|
||||||
{{% changed-in v="1.7" %}}
|
|
||||||
|
|
||||||
As of `v1.7`, this rule is deprecated and **should only be enabled if the event
|
|
||||||
does not have an [`m.mentions` property](#definition-mmentions)**.
|
|
||||||
|
|
||||||
Matches any message from a sender with the proper power level whose content
|
|
||||||
contains the text `@room`, signifying the whole room should be notified of
|
|
||||||
the event.
|
|
||||||
|
|
||||||
Definition:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"rule_id": ".m.rule.roomnotif",
|
|
||||||
"default": true,
|
|
||||||
"enabled": true,
|
|
||||||
"conditions": [
|
|
||||||
{
|
|
||||||
"kind": "event_match",
|
|
||||||
"key": "content.body",
|
|
||||||
"pattern": "@room"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"kind": "sender_notification_permission",
|
|
||||||
"key": "room"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"actions": [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
"set_tweak": "highlight"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**<a id="mruletombstone"></a>`.m.rule.tombstone`**
|
**<a id="mruletombstone"></a>`.m.rule.tombstone`**
|
||||||
|
|
||||||
Matches any state event whose type is `m.room.tombstone`. This is
|
Matches any state event whose type is `m.room.tombstone`. This is
|
||||||
|
|
@ -776,39 +709,6 @@ Definition:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Default Content Rules
|
|
||||||
|
|
||||||
<a id="_m_rule_contains_user_name"></a> **`.m.rule.contains_user_name`**
|
|
||||||
|
|
||||||
{{% changed-in v="1.7" %}}
|
|
||||||
|
|
||||||
As of `v1.7`, this rule is deprecated and **should only be enabled if the event
|
|
||||||
does not have an [`m.mentions` property](#definition-mmentions)**.
|
|
||||||
|
|
||||||
Matches any message whose content contains the local part of the user's
|
|
||||||
Matrix ID, separated by word boundaries.
|
|
||||||
|
|
||||||
Definition (as a `content` rule):
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"rule_id": ".m.rule.contains_user_name",
|
|
||||||
"default": true,
|
|
||||||
"enabled": true,
|
|
||||||
"pattern": "[the local part of the user's Matrix ID]",
|
|
||||||
"actions": [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
"set_tweak": "sound",
|
|
||||||
"value": "default"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"set_tweak": "highlight"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Default Underride Rules
|
##### Default Underride Rules
|
||||||
|
|
||||||
**`.m.rule.call`**
|
**`.m.rule.call`**
|
||||||
|
|
|
||||||
|
|
@ -34,24 +34,6 @@ properties:
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
example: {
|
example: {
|
||||||
"content": [
|
|
||||||
{
|
|
||||||
"actions": [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
"set_tweak": "sound",
|
|
||||||
"value": "default"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"set_tweak": "highlight"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"default": true,
|
|
||||||
"enabled": true,
|
|
||||||
"pattern": "alice",
|
|
||||||
"rule_id": ".m.rule.contains_user_name"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"override": [
|
"override": [
|
||||||
{
|
{
|
||||||
"actions": [],
|
"actions": [],
|
||||||
|
|
@ -113,12 +95,14 @@ example: {
|
||||||
],
|
],
|
||||||
"conditions": [
|
"conditions": [
|
||||||
{
|
{
|
||||||
"kind": "contains_display_name"
|
"kind": "event_property_contains",
|
||||||
|
"key": "content.m\\.mentions.user_ids",
|
||||||
|
"value": "@alice:example.com"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"default": true,
|
"default": true,
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"rule_id": ".m.rule.contains_display_name"
|
"rule_id": ".m.rule.is_user_mention"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"actions": [
|
"actions": [
|
||||||
|
|
|
||||||
|
|
@ -3,24 +3,6 @@
|
||||||
"type": "m.push_rules",
|
"type": "m.push_rules",
|
||||||
"content": {
|
"content": {
|
||||||
"global": {
|
"global": {
|
||||||
"content": [
|
|
||||||
{
|
|
||||||
"actions": [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
"set_tweak": "sound",
|
|
||||||
"value": "default"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"set_tweak": "highlight"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"default": true,
|
|
||||||
"enabled": true,
|
|
||||||
"pattern": "alice",
|
|
||||||
"rule_id": ".m.rule.contains_user_name"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"override": [
|
"override": [
|
||||||
{
|
{
|
||||||
"actions": [],
|
"actions": [],
|
||||||
|
|
@ -82,12 +64,14 @@
|
||||||
],
|
],
|
||||||
"conditions": [
|
"conditions": [
|
||||||
{
|
{
|
||||||
"kind": "contains_display_name"
|
"kind": "event_property_contains",
|
||||||
|
"key": "content.m\\.mentions.user_ids",
|
||||||
|
"value": "@alice:example.com"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"default": true,
|
"default": true,
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"rule_id": ".m.rule.contains_display_name"
|
"rule_id": ".m.rule.is_user_mention"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"actions": [
|
"actions": [
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue