Room

synadm room

Manipulate rooms and room membership

synadm room [OPTIONS] COMMAND [ARGS]...

delete

delete and possibly purge a room

synadm room delete [OPTIONS] ROOM_ID

Options

-u, --new-room-user-id <new_room_user_id>

If set, a new room will be created with this user ID as the creator and admin, and all users in the old room will be moved into that room. If not set, no new room will be created and the users will just be removed from the old room. The user ID must be on the local server, but does not necessarily have to belong to a registered user.

-n, --room-name <room_name>

A string representing the name of the room that new users will be invited to. Defaults to “Content Violation Notification”

-m, --message <message>

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.”

-b, --block

If set, this room will be added to a blocking list, preventing future attempts to join the room

Default

False

--no-purge

Prevent removing of all traces of the room from your database.

Default

False

Arguments

ROOM_ID

Required argument

details

get room details

synadm room details [OPTIONS] ROOM_ID

Arguments

ROOM_ID

Required argument

join

join a room

synadm room join [OPTIONS] ROOM_ID_OR_ALIAS USER_ID

Arguments

ROOM_ID_OR_ALIAS

Required argument

USER_ID

Required argument

list

list and search for rooms

synadm room list [OPTIONS]

Options

-f, --from <from_>

offset room listing by given number. This option is also used for pagination.

Default

0

-l, --limit <limit>

Maximum amount of rooms to return.

Default

100

-n, --name <name>

Filter rooms by their room name. Search term can be contained in any part of the room name)

-s, --sort <sort>

The method in which to sort the returned list of rooms.

Options

name | canonical_alias | joined_members | joined_local_members | version | creator | encryption | federatable | public | join_rules | guest_access | history_visibility | state_events

-r, --reverse

Direction of room order. If set it will reverse the sort order of –order-by method.

make-admin

grant a user room admin permission. If the user is not in the room, and it is not publicly joinable, then invite the user.

synadm room make-admin [OPTIONS] ROOM_ID

Options

-u, --user-id <user_id>

By default the server admin (the caller) is granted power, but another user can optionally be specified.

Arguments

ROOM_ID

Required argument

members

list current room members

synadm room members [OPTIONS] ROOM_ID

Arguments

ROOM_ID

Required argument

resolve

lookup room ID from alias or vice versa

synadm room resolve [OPTIONS] ROOM_ID_OR_ALIAS

Options

-r, --reverse

Fetch all room aliases corresponding to a given room ID, instead of the other way round.

Default

False

Arguments

ROOM_ID_OR_ALIAS

Required argument