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

pub struct Request<'a> {
    pub client_secret: &'a str,
    pub email: &'a str,
    pub send_attempt: UInt,
    pub next_link: Option<&'a str>,
    pub id_server: Option<&'a str>,
    pub id_access_token: Option<&'a str>,
}

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

Data for a request to the request_contact_verification_token API endpoint.

Ask for a verification token for a given 3rd party ID.

Fields

client_secret: &'a str

Client-generated secret string used to protect this session.

email: &'a str

The email address.

send_attempt: UInt

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

next_link: Option<&'a str>

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

id_server: Option<&'a str>

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

An access token previously registered with the identity server.

Required if an id_server is supplied.

Implementations

impl<'a> Request<'a>

pub fn new(
    client_secret: &'a str,
    email: &'a str,
    send_attempt: UInt
) -> Request<'a>

Creates a new Request with the given client secret, email and send-attempt counter.

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

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.

impl<'a> OutgoingNonAuthRequest for Request<'a>