Struct matrix_sdk_base::ruma::api::client::account::register::v3::Request

#[non_exhaustive]
pub struct Request {
    pub password: Option<String>,
    pub username: Option<String>,
    pub device_id: Option<OwnedDeviceId>,
    pub initial_device_display_name: Option<String>,
    pub auth: Option<AuthData>,
    pub kind: RegistrationKind,
    pub inhibit_login: bool,
    pub login_type: Option<LoginType>,
    pub refresh_token: bool,
}

Available on crate feature api and (crate features client or server) only.

Request type for the register endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

password: Option<String>

The desired password for the account.

May be empty for accounts that should not be able to log in again with a password, e.g., for guest or application service accounts.

username: Option<String>

Localpart of the desired Matrix ID.

If omitted, the homeserver MUST generate a Matrix ID local part.

device_id: Option<OwnedDeviceId>

ID of the client device.

If this does not correspond to a known client device, a new device will be created. The server will auto-generate a device_id if this is not specified.

initial_device_display_name: Option<String>

A display name to assign to the newly-created device.

Ignored if device_id corresponds to a known device.

auth: Option<AuthData>

Additional authentication information for the user-interactive authentication API.

Note that this information is not used to define how the registered user should be authenticated, but is instead used to authenticate the register call itself. It should be left empty, or omitted, unless an earlier call returned an response with status code 401.

kind: RegistrationKind

Kind of account to register

Defaults to User if omitted.

inhibit_login: bool

If true, an access_token and device_id should not be returned from this call, therefore preventing an automatic login.

login_type: Option<LoginType>

Login type used by Appservices.

Appservices can bypass the registration flows entirely by providing their token in the header and setting this login type to m.login.application_service.

refresh_token: bool

If set to true, the client supports refresh tokens.

Implementations

impl Request

pub fn new() -> Request

Creates a new Request with all parameters defaulted.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl OutgoingRequest for Request

Available on crate feature client only.

type EndpointError = UiaaResponse

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion] ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this request into an http::Request.