diff options
Diffstat (limited to 'develop/admin_api/rooms.html')
| -rw-r--r-- | develop/admin_api/rooms.html | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index 3c4aa322d5..89b39970d3 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html @@ -217,6 +217,7 @@ Specifically, rooms are selected if the search term is contained in</p> <li><code>guest_access</code> - Whether guests can join the room. One of: ["can_join", "forbidden"].</li> <li><code>history_visibility</code> - Who can see the room history. One of: ["invited", "joined", "shared", "world_readable"].</li> <li><code>state_events</code> - Total number of state_events of a room. Complexity of the room.</li> +<li><code>room_type</code> - The type of the room taken from the room's creation event; for example "m.space" if the room is a space. If the room does not define a type, the value will be <code>null</code>.</li> </ul> </li> </ul> @@ -257,7 +258,8 @@ get the "previous page" of results.</li> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 93534 + "state_events": 93534, + "room_type": "m.space" }, ... (8 hidden items) ... { @@ -274,7 +276,8 @@ get the "previous page" of results.</li> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 8345 + "state_events": 8345, + "room_type": null } ], "offset": 0, @@ -301,7 +304,8 @@ get the "previous page" of results.</li> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 8 + "state_events": 8, + "room_type": null } ], "offset": 0, @@ -328,7 +332,8 @@ get the "previous page" of results.</li> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 93534 + "state_events": 93534, + "room_type": null }, ... (98 hidden items) ... { @@ -345,7 +350,8 @@ get the "previous page" of results.</li> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 8345 + "state_events": 8345, + "room_type": "m.space" } ], "offset": 0, @@ -376,7 +382,9 @@ parameter to the value of <code>next_token</code>.</p> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 93534 + "state_events": 93534, + "room_type": "m.space" + }, ... (48 hidden items) ... { @@ -393,7 +401,9 @@ parameter to the value of <code>next_token</code>.</p> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 8345 + "state_events": 8345, + "room_type": null + } ], "offset": 100, @@ -424,6 +434,8 @@ end of the list.</p> <li><code>guest_access</code> - Whether guests can join the room. One of: ["can_join", "forbidden"].</li> <li><code>history_visibility</code> - Who can see the room history. One of: ["invited", "joined", "shared", "world_readable"].</li> <li><code>state_events</code> - Total number of state_events of a room. Complexity of the room.</li> +<li><code>room_type</code> - The type of the room taken from the room's creation event; for example "m.space" if the room is a space. +If the room does not define a type, the value will be <code>null</code>.</li> </ul> <p>The API is:</p> <pre><code>GET /_synapse/admin/v1/rooms/<room_id> @@ -446,7 +458,8 @@ end of the list.</p> "join_rules": "invite", "guest_access": null, "history_visibility": "shared", - "state_events": 93534 + "state_events": 93534, + "room_type": "m.space" } </code></pre> <h1 id="room-members-api"><a class="header" href="#room-members-api">Room Members API</a></h1> |