Struct ruma::api::client::r0::account::register::IncomingRequest [−][src]
pub struct IncomingRequest {
pub password: Option<String>,
pub username: Option<String>,
pub device_id: Option<Box<DeviceId, Global>>,
pub initial_device_display_name: Option<String>,
pub auth: Option<IncomingAuthData>,
pub kind: RegistrationKind,
pub inhibit_login: bool,
pub login_type: Option<LoginType>,
}
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
‘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<Box<DeviceId, Global>>
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
.
Trait Implementations
type EndpointError = UiaaResponse
type EndpointError = UiaaResponse
A type capturing the error conditions that can be returned in the response.
type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
Tries to turn the given http::Request
into this request type.
Auto Trait Implementations
impl RefUnwindSafe for IncomingRequest
impl Send for IncomingRequest
impl Sync for IncomingRequest
impl Unpin for IncomingRequest
impl UnwindSafe for IncomingRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more