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

pub struct Request {
    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.

Request type for the create_msisdn_validation_session endpoint.

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.

Implementations

impl Request

pub fn new( client_secret: OwnedClientSecret, country: String, phone_number: String, send_attempt: UInt, next_link: Option<String>, ) -> Request

Create a new Request with the given client secret, country code, phone number, the send_attempt number and the next link to go to after validation.

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<(), Error>

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, 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 OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this request into an http::Request.