Struct ruma::api::identity_service::association::unbind_3pid::v2::Request

pub struct Request<'a> {
    pub threepid_ownership_proof: Option<&'a ThreePidOwnershipProof>,
    pub mxid: &'a UserId,
    pub threepid: &'a ThirdPartyId,
}

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

Data for a request to the unbind_3pid API endpoint.

Remove an association between a session and a Matrix user ID.

Fields

threepid_ownership_proof: Option<&'a ThreePidOwnershipProof>

The proof that the client owns the 3PID.

If this is not provided, the request must be signed by the homeserver which controls the mxid.

mxid: &'a UserId

The Matrix user ID to remove from the 3PIDs.

threepid: &'a ThirdPartyId

The 3PID to remove.

Must match the 3PID used to generate the session if using sid and client_secret to authenticate this request.

Implementations

impl<'a> Request<'a>

pub fn new(
    threepid_ownership_proof: Option<&'a ThreePidOwnershipProof>,
    mxid: &'a UserId,
    threepid: &'a ThirdPartyId
) -> Request<'a>

Creates a Request with the given Session ID, client secret, Matrix user ID and 3PID.

Trait Implementations

impl<'a> Clone for Request<'a>

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>

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

Formats the value using the given formatter.

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

Available on crate feature client only.

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

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.