Struct ruma::api::client::to_device::send_event_to_device::v3::Request

pub struct Request {
    pub event_type: ToDeviceEventType,
    pub txn_id: OwnedTransactionId,
    pub messages: BTreeMap<OwnedUserId, BTreeMap<DeviceIdOrAllDevices, Raw<AnyToDeviceEventContent>>>,
}

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

Request type for the send_event_to_device endpoint.

Fields

event_type: ToDeviceEventType

Type of event being sent to each device.

txn_id: OwnedTransactionId

The transaction ID for this event.

Clients should generate a unique ID across requests within the same session. A session is identified by an access token, and persists when the access token is refreshed.

It will be used by the server to ensure idempotency of requests.

messages: BTreeMap<OwnedUserId, BTreeMap<DeviceIdOrAllDevices, Raw<AnyToDeviceEventContent>>>

Messages to send.

Different message events can be sent to different devices in the same request, but all events within one request must be of the same type.

Implementations

impl Request

pub fn new_raw( event_type: ToDeviceEventType, txn_id: OwnedTransactionId, messages: BTreeMap<OwnedUserId, BTreeMap<DeviceIdOrAllDevices, Raw<AnyToDeviceEventContent>>>, ) -> Request

Creates a new Request with the given event type, transaction ID and raw messages.

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

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, FromHttpRequestError>

where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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.