Enum UserCommand 

pub(crate) enum UserCommand {
    CreateUser {
        username: String,
        password: Option<String>,
    },
    ResetPassword {
        username: String,
        password: Option<String>,
    },
    Deactivate {
        no_leave_rooms: bool,
        user_id: String,
    },
    DeactivateAll {
        no_leave_rooms: bool,
        force: bool,
    },
    DeleteDevice {
        user_id: OwnedUserId,
        device_id: OwnedDeviceId,
    },
    LastActive {
        limit: Option<usize>,
    },
    ListUsers,
    ListJoinedRooms {
        user_id: String,
    },
    ForceJoinRoom {
        user_id: String,
        room: OwnedRoomOrAliasId,
    },
    ForceLeaveRoom {
        user_id: String,
        room_id: OwnedRoomOrAliasId,
    },
    RejectInvites {
        user_id: String,
        reason: Option<String>,
    },
    ForceDemote {
        user_id: String,
        room_id: OwnedRoomOrAliasId,
    },
    ForcePromote {
        user_id: String,
        room_id: OwnedRoomOrAliasId,
    },
    MakeUserAdmin {
        user_id: String,
    },
    PutRoomTag {
        user_id: String,
        room_id: OwnedRoomId,
        tag: String,
    },
    DeleteRoomTag {
        user_id: String,
        room_id: OwnedRoomId,
        tag: String,
    },
    GetRoomTags {
        user_id: String,
        room_id: OwnedRoomId,
    },
    RedactEvent {
        event_id: OwnedEventId,
    },
    ForceJoinListOfLocalUsers {
        room: OwnedRoomOrAliasId,
        yes_i_want_to_do_this: bool,
    },
    ForceJoinAllLocalUsers {
        room: OwnedRoomOrAliasId,
        yes_i_want_to_do_this: bool,
    },
}

Variants

CreateUser

• Create a new user

Fields

username: String

Username of the new user

password: Option<String>

Password of the new user, if unspecified one is generated

ResetPassword

• Reset user password

Fields

username: String

Username of the user for whom the password should be reset

password: Option<String>

New password for the user, if unspecified one is generated

Deactivate

• Deactivate a user

User will be removed from all rooms by default. Use –no-leave-rooms to not leave all rooms by default.

Fields

no_leave_rooms: bool

user_id: String

DeactivateAll

• Deactivate a list of users

Recommended to use in conjunction with list-local-users.

Users will be removed from joined rooms by default.

Can be overridden with –no-leave-rooms.

Removing a mass amount of users from a room may cause a significant amount of leave events. The time to leave rooms may depend significantly on joined rooms and servers.

This command needs a newline separated list of users provided in a Markdown code block below the command.

Fields

no_leave_rooms: bool

Does not leave any rooms the user is in on deactivation

force: bool

Also deactivate admin accounts and will assume leave all rooms too

DeleteDevice

• Deletes a user’s device.

Fields

user_id: OwnedUserId

device_id: OwnedDeviceId

LastActive

• List local users by recent activity.

Fields

limit: Option<usize>

ListUsers

• List local users in the database

ListJoinedRooms

• Lists all the rooms (local and remote) that the specified user is joined in

Fields

user_id: String

ForceJoinRoom

• Manually join a local user to a room.

Fields

user_id: String

room: OwnedRoomOrAliasId

ForceLeaveRoom

• Manually leave a local user from a room.

Fields

user_id: String

room_id: OwnedRoomOrAliasId

RejectInvites

• Reject all pending invites for a local user.

Fields

user_id: String

reason: Option<String>

Optional reason attached to each rejection.

ForceDemote

• Forces the specified user to drop their power levels to the room default, if their permissions allow and the auth check permits

Fields

user_id: String

room_id: OwnedRoomOrAliasId

ForcePromote

• Force promote

Fields

user_id: String

room_id: OwnedRoomOrAliasId

MakeUserAdmin

• Grant server-admin privileges to a user.

Fields

user_id: String

PutRoomTag

• Puts a room tag for the specified user and room ID.

This is primarily useful if you’d like to set your admin room to the special “System Alerts” section in Element as a way to permanently see your admin room without it being buried away in your favourites or rooms. To do this, you would pass your user, your admin room’s internal ID, and the tag name m.server_notice.

Fields

user_id: String

room_id: OwnedRoomId

tag: String

DeleteRoomTag

• Deletes the room tag for the specified user and room ID

Fields

user_id: String

room_id: OwnedRoomId

tag: String

GetRoomTags

• Gets all the room tags for the specified user and room ID

Fields

user_id: String

room_id: OwnedRoomId

RedactEvent

• Attempts to forcefully redact the specified event ID from the sender user

This is only valid for local users

Fields

event_id: OwnedEventId

ForceJoinListOfLocalUsers

• Force joins a specified list of local users to join the specified room.

Specify a codeblock of usernames.

Requires the --yes-i-want-to-do-this flag.

Fields

room: OwnedRoomOrAliasId

yes_i_want_to_do_this: bool

ForceJoinAllLocalUsers

• Force joins all local users to the specified room.

Requires the --yes-i-want-to-do-this flag.

Fields

room: OwnedRoomOrAliasId

yes_i_want_to_do_this: bool

Trait Implementations

impl Debug for UserCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for UserCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for UserCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand