Skip to content

Commit d260c4a

Browse files
committed
MSCXXXX: Mentions for device IDs
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
1 parent 5beaf2e commit d260c4a

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

proposals/XXXX-device-id-mentions.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# MSCXXXX: Mentions for device IDs
2+
3+
The [`m.mentions`] content property on events allows senders to include an indicator about whether
4+
the event should triggger a specialised notification for some or all room members. Among others,
5+
this can be used to direct events at a certain recipient group within the room. It is, however,
6+
not currently possible to direct events at a certain subset of devices within a room. This can
7+
be helpful, for instance, in cases where devices with different capabilities are participating
8+
in the room and the sender wants to provide a hint on which devices the recipient should pick up
9+
the message. This proposal makes it possible to mention specific devices via the existing
10+
[`m.mentions`] mechanism.
11+
12+
## Proposal
13+
14+
A new optional property `device_ids` is introduced in [`m.mentions`] to allow specifying an array
15+
of device IDs to be mentioned by the message.
16+
17+
```json5
18+
"m.mentions": {
19+
"device_ids": ["ABC1234"]
20+
}
21+
```
22+
23+
It is legal for `room` and `user_ids` to be present within `m.mentions` simultaneously to `device_ids`.
24+
25+
## Potential issues
26+
27+
None.
28+
29+
## Alternatives
30+
31+
None.
32+
33+
## Security considerations
34+
35+
Device IDs are already disclosed when sending messages in encrypted rooms. Allowing their use within
36+
`m.mentions` does, therefore, not present an additional metadata leak.
37+
38+
## Unstable prefix
39+
40+
Until this proposal is accepted into the spec, implementations should refer to `device_ids` as
41+
`de.gematik.mscXXXX.device_ids`.
42+
43+
## Dependencies
44+
45+
None.
46+
47+
[`m.mentions`]: https://spec.matrix.org/v1.14/client-server-api/#definition-mmentions

0 commit comments

Comments
 (0)