Struct matrix_sdk_base::ruma::events::call::member::CallMemberEventContent

#[non_exhaustive]
pub struct CallMemberEventContent {
    pub memberships: Vec<Membership>,
}

Available on crate feature unstable-msc3401 only.

The member state event for a matrixRTC session.

This is the object containing all the data related to a matrix users participation in a matrixRTC session. It consists of memberships / sessions.

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.

memberships: Vec<Membership>

A list of all the memberships that user currently has in this room.

There can be multiple ones in cases the user participates with multiple devices or there are multiple RTC applications running.

e.g. a call and a spacial experience.

Important: This includes expired memberships. To retrieve a list including only valid memberships, see active_memberships.

Implementations

impl CallMemberEventContent

pub fn new(memberships: Vec<Membership>) -> CallMemberEventContent

Creates a new CallMemberEventContent.

pub fn active_memberships( &self, origin_server_ts: Option<MilliSecondsSinceUnixEpoch> ) -> Vec<&Membership>

All non expired memberships in this member event.

In most cases you want tu use this method instead of the public memberships field. The memberships field will also include expired events.

Arguments

• origin_server_ts - optionally the origin_server_ts can be passed as a fallback in case the Membership does not contain created_ts. (origin_server_ts will be ignored if created_ts is Some)

pub fn set_created_ts_if_none( &mut self, origin_server_ts: MilliSecondsSinceUnixEpoch )

Set the created_ts of each Membership in this event.

Each call member event contains the origin_server_ts and content.create_ts. content.create_ts is undefined for the initial event of a session (because the origin_server_ts is not known on the client). In the rust sdk we want to copy over the origin_server_ts of the event into the content. (This allows to use MinimalStateEvents and still be able to determine if a membership is expired)

Trait Implementations

impl Clone for CallMemberEventContent

fn clone(&self) -> CallMemberEventContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallMemberEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallMemberEventContent

fn deserialize<__D>( __deserializer: __D ) -> Result<CallMemberEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for CallMemberEventContent

type EventType = StateEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> <CallMemberEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.

impl From<CallMemberEventContent> for AnyStateEventContent

fn from(c: CallMemberEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl RedactContent for CallMemberEventContent

type Redacted = RedactedCallMemberEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedCallMemberEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for CallMemberEventContent

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateEventContent for CallMemberEventContent

type StateKey = OwnedUserId

The type of the event’s state_key field.

impl StaticEventContent for CallMemberEventContent

const TYPE: &'static str = "org.matrix.msc3401.call.member"

The event type.

impl StaticStateEventContent for CallMemberEventContent

type PossiblyRedacted = PossiblyRedactedCallMemberEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<CallMemberEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.