matrix-moderation-tool/docs/room_functions.md
2023-08-18 20:48:46 +08:00

3.4 KiB

Room Commands

  1. List details of a room.

Shows comprehensive information about a specific room.

https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#room-details-api

  1. List the members of a room.

Displays all the members who are part of a particular room.

https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#room-members-api

  1. Export the state events of a room.

Retrieves and saves the state events (such as topic changes, member joins) of a specific room.

https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#room-state-api

  1. Export the state events of multiple rooms.

Gathers and saves the state events from several rooms simultaneously.

  1. List rooms in public directory.

Displays all the rooms that are publicly available and listed in the directory.

https://spec.matrix.org/legacy/client_server/r0.6.0.html#get-matrix-client-r0-publicrooms

  1. Remove a room from the public directory.

Takes a specific room off the public directory, making it less accessible to users browsing the directory.

  1. Remove multiple rooms from the public directory.

Removes several rooms from the public directory at once.

  1. Redact a room event.

Conceals specific events in a room, such as messages or media, from being visible.

  1. List/Download all media in a room.

Displays and offers the option to download all media files shared in a specific room.

https://matrix-org.github.io/synapse/latest/admin_api/media_admin_api.html#list-all-media-in-a-room

  1. Download media from multiple rooms.

Enables downloading of media files shared across several rooms.

  1. Quarantine all media in a room.

Isolates and restricts access to all media files in a specific room, usually due to concerns over inappropriate content.

https://matrix-org.github.io/synapse/latest/admin_api/media_admin_api.html#quarantining-media-in-a-room

  1. Shutdown a room.

Terminates a room, preventing further activities or messages in it.

https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#version-2-new-version

  1. Shutdown multiple rooms.

Closes several rooms simultaneously, halting any ongoing activity in them.

  1. Delete a room.

Permanently removes a room and all its content.

  1. Delete multiple rooms.

Erases several rooms and their content from the server at once.

  1. Purge the event history of a room to a specific timestamp.

Deletes all events in a room up to a certain point in time, preserving events after that timestamp.

  1. Purge the event history of multiple rooms to a specific timestamp.

Clears the events in several rooms up to a specified timestamp.

  1. Get blocked status for room.

Checks if a room is blocked and restricted from user access.

https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#get-block-status

  1. Block a room.

Restricts access to a room, preventing users from joining or interacting in it.

https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#block-or-unblock-a-room

  1. Unblock a room.

Restores access to a previously blocked room, allowing users to join and participate once more.

Note: Managing rooms is a sensitive operation, especially when dealing with content and user privacy. Ensure you have the required permissions and handle operations with care.