Struct ruma::api::client::membership::get_member_events::v3::IncomingRequest

pub struct IncomingRequest {
    pub room_id: OwnedRoomId,
    pub at: Option<String>,
    pub membership: Option<MembershipEventFilter>,
    pub not_membership: Option<MembershipEventFilter>,
}

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

‘Incoming’ variant of Request.

Fields

room_id: OwnedRoomId

The room to get the member events for.

at: Option<String>

The point in time (pagination token) to return members for in the room.

This token can be obtained from a prev_batch token returned for each room by the sync API.

membership: Option<MembershipEventFilter>

The kind of memberships to filter for.

Defaults to no filtering if unspecified. When specified alongside not_membership, the two parameters create an ‘or’ condition: either the membership is the same as membership or is not the same as not_membership.

not_membership: Option<MembershipEventFilter>

The kind of memberships to exclude from the results.

Defaults to no filtering if unspecified.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, 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.