Struct ruma::api::appservice::event::push_events::v1::Request
source · pub struct Request {
pub txn_id: OwnedTransactionId,
pub events: Vec<Raw<AnyTimelineEvent>>,
pub device_lists: DeviceLists,
pub device_one_time_keys_count: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, BTreeMap<OneTimeKeyAlgorithm, UInt>>>,
pub device_unused_fallback_key_types: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Vec<OneTimeKeyAlgorithm>>>,
pub ephemeral: Vec<Edu>,
pub to_device: Vec<Raw<AnyToDeviceEvent>>,
}
Available on crate feature
api
and (crate features appservice-api-c
or appservice-api-s
) only.Expand description
Request type for the push_events
endpoint.
Fields§
§txn_id: OwnedTransactionId
The transaction ID for this set of events.
Homeservers generate these IDs and they are used to ensure idempotency of results.
events: Vec<Raw<AnyTimelineEvent>>
A list of events.
device_lists: DeviceLists
Available on crate feature
unstable-msc3202
only.Information on E2E device updates.
device_one_time_keys_count: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, BTreeMap<OneTimeKeyAlgorithm, UInt>>>
Available on crate feature
unstable-msc3202
only.The number of unclaimed one-time keys currently held on the server for this device, for each algorithm.
device_unused_fallback_key_types: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Vec<OneTimeKeyAlgorithm>>>
Available on crate feature
unstable-msc3202
only.A list of key algorithms for which the server has an unused fallback key for the device.
ephemeral: Vec<Edu>
Available on crate feature
unstable-msc2409
only.A list of EDUs.
to_device: Vec<Raw<AnyToDeviceEvent>>
Available on crate feature
unstable-msc2409
only.A list of to-device messages.
Implementations§
source§impl Request
impl Request
sourcepub fn new(
txn_id: OwnedTransactionId,
events: Vec<Raw<AnyTimelineEvent>>,
) -> Request
pub fn new( txn_id: OwnedTransactionId, events: Vec<Raw<AnyTimelineEvent>>, ) -> Request
Creates an Request
with the given transaction ID and list of events.
Trait Implementations§
source§impl IncomingRequest for Request
Available on crate feature server
only.
impl IncomingRequest for Request
Available on crate feature
server
only.source§type EndpointError = MatrixError
type EndpointError = MatrixError
A type capturing the error conditions that can be returned in the response.
source§type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
source§impl OutgoingRequest for Request
Available on crate feature client
only.
impl OutgoingRequest for Request
Available on crate feature
client
only.source§type EndpointError = MatrixError
type EndpointError = MatrixError
A type capturing the expected error conditions the server can return.
source§type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
source§fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
source§fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity.