From 110234827efd875b8605e8e472b9e2fa257e0edc Mon Sep 17 00:00:00 2001 From: Jimmy Cuadra Date: Thu, 13 Jun 2019 17:06:42 -0700 Subject: [PATCH] Add a note about m.room.member's invite_room_state data. --- src/room/member.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/room/member.rs b/src/room/member.rs index 170631c7..ce28a146 100644 --- a/src/room/member.rs +++ b/src/room/member.rs @@ -18,7 +18,10 @@ state_event! { /// /// This event may also include an `invite_room_state` key inside the event's unsigned data. If /// present, this contains an array of `StrippedState` events. These events provide information - /// on a subset of state events such as the room name. + /// on a subset of state events such as the room name. Note that ruma-events treats unsigned + /// data on events as arbitrary JSON values, and the ruma-events types for this event don't + /// provide direct access to these `invite_room_state`. If you need this data, you must extract + /// and convert it from a `serde_json::Value` yourself. /// /// The user for which a membership applies is represented by the `state_key`. Under some /// conditions, the `sender` and `state_key` may not match - this may be interpreted as the