Struct ruma_client_api::r0::account::register::Request

pub struct Request {
    pub password: Option<String>,
    pub username: Option<String>,
    pub device_id: Option<DeviceId>,
    pub initial_device_display_name: Option<String>,
    pub auth: Option<AuthData>,
    pub kind: Option<RegistrationKind>,
    pub inhibit_login: bool,
}

Data for a request to the register API endpoint.

Register an account on this homeserver.

Fields

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>

local part of the desired Matrix ID.

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

device_id: Option<DeviceId>

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: Option<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.

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

Formats the value using the given formatter.

impl Endpoint for Request

type Response = Response

Data returned in a successful response from the endpoint.

type ResponseError = UiaaResponse

Error type returned when response from endpoint fails.

const METADATA: Metadata

Metadata for the #name endpoint.

impl TryFrom<Request<Vec<u8>>> for Request

type Error = FromHttpRequestError

The type returned in the event of a conversion error.

fn try_from(request: Request<Vec<u8>>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = IntoHttpError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.