Struct ruma::api::appservice::event::push_events::v1::IncomingRequest

pub struct IncomingRequest {
    pub txn_id: String,
    pub events: Vec<Raw<AnyRoomEvent>, Global>,
}

This is supported on crate feature api and (crate features appservice-api or appservice-api-c or appservice-api-s) only.

‘Incoming’ variant of Request.

Fields

txn_id: String

The transaction ID for this set of events.

Homeservers generate these IDs and they are used to ensure idempotency of results.

events: Vec<Raw<AnyRoomEvent>, Global>

A list of events.

Implementations

impl IncomingRequest

pub fn new(
    txn_id: String,
    events: Vec<Raw<AnyRoomEvent>, Global>
) -> IncomingRequest

Creates an IncomingRequest with the given transaction ID and list of events.

pub fn try_into_sync_response(
    self,
    next_batch: impl Into<String>
) -> Result<Response, Error>

Consumes the IncomingRequest and tries to convert it to a sync_events::Response

This is a helper conversion in cases where it’s easier to work with sync_events::Response instead of the original push_events::IncomingRequest. It puts all events with a room_id into the JoinedRoom’s timeline. The rationale behind that is that incoming Appservice transactions from the homeserver are not necessarily bound to a specific user but can cover a multitude of namespaces, and as such the Appservice basically only “observes joined rooms”.

Note: Currently homeservers only push PDUs to appservices, no EDUs. There’s the open MSC2409 regarding supporting EDUs in the future, though it seems to be planned to put EDUs into a different JSON key than events to stay backwards compatible.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

type EndpointError = MatrixError

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.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_from_http_request<T>(
    request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
    T: AsRef<[u8]>, 

Tries to turn the given http::Request into this request type.