[]Struct matrix_sdk_base::api::r0::to_device::send_event_to_device::Request

#[non_exhaustive]pub struct Request<'a> {
    pub event_type: EventType,
    pub txn_id: &'a str,
    pub messages: BTreeMap<UserId, BTreeMap<DeviceIdOrAllDevices, Box<RawValue, Global>>>,
}

Data for a request to the send_event_to_device API endpoint.

Send an event to a device or devices.

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.
event_type: EventType

Type of event being sent to each device.

txn_id: &'a str

A request identifier unique to the access token used to send the request.

messages: BTreeMap<UserId, BTreeMap<DeviceIdOrAllDevices, Box<RawValue, Global>>>

A map of users to devices to a content for a message event to be sent to the user's device. Individual message events can be sent to devices, but all events must be of the same type. The content's type for this field will be updated in a future release, until then you can create a value using serde_json::value::to_raw_value.

Implementations

impl<'a> Request<'a>

pub fn new(
    event_type: EventType,
    txn_id: &'a str,
    messages: BTreeMap<UserId, BTreeMap<DeviceIdOrAllDevices, Box<RawValue, Global>>>
) -> Request<'a>

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

Trait Implementations

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

impl<'a> Debug for Request<'a>

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 for the send_event_to_device API endpoint.

Auto Trait Implementations

impl<'a> RefUnwindSafe for Request<'a>[src]

impl<'a> Send for Request<'a>[src]

impl<'a> Sync for Request<'a>[src]

impl<'a> Unpin for Request<'a>[src]

impl<'a> UnwindSafe for Request<'a>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> AsyncTraitDeps for T where
    T: Send + Sync + Debug
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Conv for T

impl<T> Conv for T

impl<T> FmtForward for T

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pipe for T where
    T: ?Sized

impl<T> Pipe for T

impl<T> PipeAsRef for T

impl<T> PipeBorrow for T

impl<T> PipeDeref for T

impl<T> PipeRef for T

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

impl<T> Tap for T

impl<T, U> TapAsRef<U> for T where
    U: ?Sized

impl<T, U> TapBorrow<U> for T where
    U: ?Sized

impl<T> TapDeref for T

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> TryConv for T

impl<T> TryConv for T

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,