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 used for pagination.
- Default
0
-
-l
,
--limit
<limit>
¶ Maximum amount of rooms to return.
- Default
100
-
-n
,
--name
<name>
¶ Filter rooms by parts of their room name, canonical alias and room id.
-
-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
power-levels¶
List user’s power levels set in rooms.
A combination of commands room list and room state. It enriches the room list response with a list of users and their corresponding power levels set. It only displays a subset of the available information (room name, id, aliases and power levels). Increase the number of rooms fetched using –limit/-l (default: 10) or use the pagination option –from/-f to go beyond the default. Use –name/-n to search. This command can require quite some time to complete depending on those options.
synadm room power-levels [OPTIONS]
Options
-
-i
,
--room-id
<room_id>
¶ View power levels of this room only.
-
-a
,
--all-details
¶
Show detailed information about each room. The default is to only show room_id, name, canonical_alias and power_levels.
-
-f
,
--from
<from_>
¶ Offset room listing by given number. This option is used for pagination.
- Default
0
-
-l
,
--limit
<limit>
¶ Maximum amount of rooms to return.
- Default
10
-
-n
,
--name
<name>
¶ Filter rooms by parts of their room name, canonical alias and room id.
-
-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.
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
search¶
An alias to synadm room list -n <search-term>.
synadm room search [OPTIONS] SEARCH_TERM
Options
-
-f
,
--from
<from_>
¶ Offset room listing by given number. This option is used for pagination.
- Default
0
-
-l
,
--limit
<limit>
¶ Maximum amount of rooms to return.
- Default
100
-
-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.
Arguments
-
SEARCH_TERM
¶
Required argument