Struct ruma::api::federation::thirdparty::bind_callback::v1::Request

pub struct Request<'a> {
    pub medium: &'a Medium,
    pub address: &'a str,
    pub mxid: &'a UserId,
    pub invites: &'a [ThirdPartyInvite],
}

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

Data for a request to the bind_callback API endpoint.

Used by identity servers to notify the homeserver that one of its users has bound a third party identifier successfully

Fields

medium: &'a Medium

The type of third party identifier.

Currently only Medium::Email is supported.

address: &'a str

The third party identifier itself.

For example: an email address.

mxid: &'a UserId

The user that is now bound to the third party identifier.

invites: &'a [ThirdPartyInvite]

A list of pending invites that the third party identifier has received.

Implementations

impl<'a> Request<'a>

pub fn new(
    medium: &'a Medium,
    address: &'a str,
    mxid: &'a UserId,
    invites: &'a [ThirdPartyInvite]
) -> Request<'a>

Creates a new Request with the given medium, address, user ID and third party invites.

pub fn email(
    address: &'a str,
    mxid: &'a UserId,
    invites: &'a [ThirdPartyInvite]
) -> Request<'a>

Creates a new Request with the given email address, user ID and third party invites.

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.

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