Struct matrix_sdk_base::ruma::api::client::appservice::request_ping::v1::Request

#[non_exhaustive]
pub struct Request {
    pub appservice_id: String,
    pub transaction_id: Option<OwnedTransactionId>,
}

Available on crate feature api and (crate features client or server) only.

Request type for the request_ping endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

appservice_id: String

The appservice ID of the appservice to ping.

This must be the same as the appservice whose as_token is being used to authenticate the request.

transaction_id: Option<OwnedTransactionId>

Transaction ID that is passed through to the POST /_matrix/app/v1/ping call.

Implementations

impl Request

pub fn new(appservice_id: String) -> Request

Creates a new Request with the given appservice ID.

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 OutgoingRequest for Request

Available on crate feature client only.

type EndpointError = Error

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