Document that /rooms/:room_id/members/list yields profile and presence information about room members

This commit is contained in:
Paul "LeoNerd" Evans 2014-08-15 17:24:02 +01:00
parent 9c41f635a9
commit 1731781145

View File

@ -694,6 +694,16 @@ Invite/Joining/Leaving a room
Required keys: Required keys:
membership : [join|invite] - The membership state of $user_id in room membership : [join|invite] - The membership state of $user_id in room
$room_id. $room_id.
Optional keys:
displayname,
avatar_url : String fields from the member user's profile
state,
status_msg,
mtime_age : Presence information
These optional keys provide extra information that the client is likely to
be interested in so it doesn't have to perform an additional profile or
presence information fetch.
Where: Where:
join - Indicate you ($user_id) are joining the room $room_id. join - Indicate you ($user_id) are joining the room $room_id.