From c43404ecd6e51a17568147fa6aa952994bb577e4 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 9 Nov 2021 13:12:11 +0000 Subject: deploy: b6f4d122efb86e3fc44e358cf573dc2caa6ff634 --- develop/print.html | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'develop/print.html') diff --git a/develop/print.html b/develop/print.html index df69fe110a..5a15a235ec 100644 --- a/develop/print.html +++ b/develop/print.html @@ -10266,12 +10266,16 @@ leave the room without any information.

The new room will be created with the user specified by the new_room_user_id parameter as room administrator and will contain a message explaining what happened. Users invited to the new room will have power level -10 by default, and thus be unable to speak.

-

If block is True it prevents new joins to the old room.

+

If block is true, users will be prevented from joining the old room. +This option can also be used to pre-emptively block a room, even if it's unknown +to this homeserver. In this case, the room will be blocked, and no further action +will be taken. If block is false, attempting to delete an unknown room is +invalid and will be rejected as a bad request.

This API will remove all trace of the old room from your database after removing all local users. If purge is true (the default), all traces of the old room will be removed from your database after removing all local users. If you do not want this to happen, set purge to false. -Depending on the amount of history being purged a call to the API may take +Depending on the amount of history being purged, a call to the API may take several minutes or longer.

The local server will only have the power to move local user and room aliases to the new room. Users on other servers will be unaffected.

@@ -10319,8 +10323,9 @@ invited to. Defaults to Content Violation Notification
  • message - Optional. A string containing the first message that will be sent as new_room_user_id in the new room. Ideally this will clearly convey why the original room was shut down. Defaults to Sharing illegal content on this server is not permitted and rooms in violation will be blocked.
    • -
  • block - Optional. If set to true, this room will be added to a blocking list, preventing -future attempts to join the room. Defaults to false.
    • +
  • block - Optional. If set to true, this room will be added to a blocking list, +preventing future attempts to join the room. Rooms can be blocked +even if they're not yet known to the homeserver. Defaults to false.
  • purge - Optional. If set to true, it will remove all traces of the room from your database. Defaults to true.
  • force_purge - Optional, and ignored unless purge is true. If set to true, it @@ -10336,7 +10341,8 @@ clients in a confused state.
  • failed_to_kick_users - An array of users (user_id) that that were not kicked.
  • local_aliases - An array of strings representing the local aliases that were migrated from the old room to the new.
    • -
  • new_room_id - A string representing the room ID of the new room.
    • +
  • new_room_id - A string representing the room ID of the new room, or null if +no such room was created.

    • Undoing room deletions

    Note: This guide may be outdated by the time you read it. By nature of room deletions being performed at the database level, -- cgit 1.5.1