Struct ruma::api::client::r0::contact::request_contact_verification_token::IncomingRequest

pub struct IncomingRequest {
    pub client_secret: Box<ClientSecret, Global>,
    pub email: String,
    pub send_attempt: UInt,
    pub next_link: Option<String>,
    pub id_server: Option<String>,
    pub id_access_token: Option<String>,
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

‘Incoming’ variant of Request.

Fields

client_secret: Box<ClientSecret, Global>

Client-generated secret string used to protect this session.

email: String

The email address.

send_attempt: UInt

Used to distinguish protocol level retries from requests to re-send the email.

next_link: Option<String>

A URL for the identity server to redirect the user to after validation is completed.

id_server: Option<String>

The identity server to send the onward request to as a hostname with an appended colon and port number if the port is not the default.

id_access_token: Option<String>

An access token previously registered with the identity server.

Required if an id_server is supplied.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

type EndpointError = Error

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.

pub const METADATA: Metadata

Metadata about the endpoint.

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.

impl IncomingNonAuthRequest for IncomingRequest