Struct ruma::api::client::account::register::v3::IncomingRequest

pub struct IncomingRequest {
    pub password: Option<String>,
    pub username: Option<String>,
    pub device_id: Option<OwnedDeviceId>,
    pub initial_device_display_name: Option<String>,
    pub auth: Option<IncomingAuthData>,
    pub kind: RegistrationKind,
    pub inhibit_login: bool,
    pub login_type: Option<LoginType>,
    pub refresh_token: bool,
}

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

‘Incoming’ variant of Request.

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>

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<IncomingAuthData>

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.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

type EndpointError = UiaaResponse

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
    B: AsRef<[u8]>,
    S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl IncomingNonAuthRequest for IncomingRequest

Available on crate feature server only.