Skip to content

Commit

Permalink
Spec unsigned.membership property, per MSC4115 (#1847)
Browse files Browse the repository at this point in the history
  • Loading branch information
richvdh authored Jun 10, 2024
1 parent 1b40a77 commit 9605763
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1847.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add the new `unsigned.membership` property to events served over the client-server API, as per [MSC4115](https://github.com/matrix-org/matrix-spec-proposals/pull/4115).
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ properties:
"origin_server_ts": 1632491098485,
"unsigned": {
"age": 1257,
"membership": "leave"
}
}
transaction_id:
Expand All @@ -112,3 +113,23 @@ properties:
this.
title: EventContent
type: object
membership:
description: |
The room membership of the user making the request, at the time of the event.
This property is the value of the `membership` property of the
requesting user's [`m.room.member`](/client-server-api#mroommember)
state at the point of the event, including any changes caused by the
event. If the user had yet to join the room at the time of the event
(i.e, they have no `m.room.member` state), this property is set to
`leave`.
Homeservers SHOULD populate this property
wherever practical, but they MAY omit it if necessary (for example,
if calculating the value is expensive, servers might choose to only
implement it in encrypted rooms). The property is *not* normally populated
in events pushed to application services via the application service transaction API
(where there is no clear definition of "requesting user").
type: string
example: join
x-addedInMatrixVersion: "1.11"
3 changes: 2 additions & 1 deletion data/event-schemas/examples/core/room_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"sender": "@example:example.org",
"origin_server_ts": 1432735824653,
"unsigned": {
"age": 1234
"age": 1234,
"membership": "join"
}
}

0 comments on commit 9605763

Please sign in to comment.