Struct ruma::api::identity_service::association::msisdn::create_msisdn_validation_session::v2::IncomingRequest

pub struct IncomingRequest {
    pub client_secret: OwnedClientSecret,
    pub country: String,
    pub phone_number: String,
    pub send_attempt: UInt,
    pub next_link: Option<String>,
}

Available on crate feature api and (crate features identity-service-api-c or identity-service-api-s) only.

‘Incoming’ variant of Request.

Fields

client_secret: OwnedClientSecret

A unique string generated by the client, and used to identify the validation attempt.

country: String

The two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone_number should be parsed as if it were dialled from.

phone_number: String

The phone number to validate.

send_attempt: UInt

The server will only send an SMS if the send_attempt is a number greater than the most recent one which it has seen, scoped to that country + phone_number + client_secret triple.

next_link: Option<String>

When the validation is completed, the identity server will redirect the user to this URL.

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 = MatrixError

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.