Define history_not_shared withheld code.

This commit is contained in:
Richard van der Hoff 2026-06-23 15:49:20 +01:00
parent adde146d48
commit 126c3f0a49
2 changed files with 9 additions and 1 deletions

View file

@ -31,6 +31,7 @@ properties:
- m.unauthorised
- m.unavailable
- m.no_olm
- m.history_not_shared
description: |-
A machine-readable code for why the key was not sent. Codes beginning
with `m.` are reserved for codes defined in the Matrix

View file

@ -8,7 +8,7 @@ description: |-
This event type is used to indicate that the sender is not sharing room keys
with the recipient. It is sent as a to-device event.
Possible values for `code` include:
The following values for `code` are defined:
* `m.blacklisted`: the user/device was blacklisted.
* `m.unverified`: the user/device was not verified, and the sender is only
@ -19,6 +19,13 @@ description: |-
* `m.unavailable`: sent in reply to a key request if the device that the
key is requested from does not have the requested key.
* `m.no_olm`: an olm session could not be established.
* **[Added in `v1.19`]** `m.history_not_shared`: when used as part of a
[`RoomKeyBundle` structure](/client-server-api/#definition-roomkeybundle),
indicates to the recipient of the bundle that the corresponding room key
was not marked as
[shareable](/client-server-api/#shareable-encryption-sessions) by the
sender. Clients SHOULD NOT use this `code` in a `m.room_key.withheld`
event.
In most cases, this event refers to a specific room key. The one exception to
this is when the sender is unable to establish an olm session with the