Skip to content

Commit 4e1b562

Browse files
authored
Add description of m.receipt behaviour to MSC2285 (#3875)
This appears to have been missed/edited out as part of one or more refactors of the MSC.
1 parent c3eb6ac commit 4e1b562

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

proposals/2285-hidden-read-receipts.md

+27
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,33 @@ federated. Servers MUST NOT send receipts of `receiptType` `m.read.private` to
7373
any other user than the sender. Servers also MUST NOT send receipts of
7474
`receiptType` `m.read.private` to any server over federation.
7575

76+
As implied by adding a new `receiptType`, `m.read.private` receipts are echoed
77+
back to clients through [`m.receipt`](https://spec.matrix.org/v1.3/client-server-api/#mreceipt).
78+
The structure is the same as `m.read`. For example:
79+
80+
```json
81+
{
82+
"type": "m.receipt",
83+
"content": {
84+
"$event": {
85+
"m.read": {
86+
"@public_user:example.org": {
87+
"ts": 1661385089714
88+
}
89+
},
90+
"m.read.private": {
91+
"@self:example.org": {
92+
"ts": 1661385103450
93+
}
94+
}
95+
}
96+
}
97+
}
98+
```
99+
100+
Due to the nature of private read receipts, the `m.read.private` map in `m.receipt`
101+
should only ever have the user's own ID.
102+
76103
## Security considerations
77104

78105
Servers could act as if `m.read.private` is the same as `m.read` so the user

0 commit comments

Comments
 (0)