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

pub struct Request<'a> {
    pub client_secret: &'a str,
    pub country: &'a str,
    pub phone_number: &'a str,
    pub send_attempt: UInt,
    pub next_link: Option<&'a str>,
}

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

Data for a request to the create_msisdn_validation_session API endpoint.

Creates a session for validating a phone number.

Fields

client_secret: &'a str

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

country: &'a str

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: &'a str

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<&'a str>

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

Implementations

impl<'a> Request<'a>

pub fn new(
    client_secret: &'a str,
    country: &'a str,
    phone_number: &'a str,
    send_attempt: UInt,
    next_link: Option<&'a str>
) -> Request<'a>

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<'a> Clone for Request<'a>

pub fn clone(&self) -> Request<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = MatrixError

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_into_http_request<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
    T: Default + BufMut, 

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