Enum CallMemberEventContent 

#[non_exhaustive]
pub enum CallMemberEventContent {
    LegacyContent(LegacyMembershipContent),
    SessionContent(SessionMembershipData),
    Empty(EmptyMembershipData),
}

Available on crate feature events 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.

This is a unit struct with the enum CallMemberEventContent because a Ruma state event cannot be an enum and we need this to be an untagged enum for parsing purposes. (see CallMemberEventContent)

This struct also exposes allows to call the methods from CallMemberEventContent.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LegacyContent(LegacyMembershipContent)

The legacy format for m.call.member events. (An array of memberships. The devices of one user.)

SessionContent(SessionMembershipData)

Normal membership events. One event per membership. Multiple state keys will be used to describe multiple devices for one user.

Empty(EmptyMembershipData)

An empty content means this user has been in a rtc session but is not anymore.

Implementations

impl CallMemberEventContent

pub fn new_legacy( memberships: Vec<LegacyMembershipData>, ) -> CallMemberEventContent

Creates a new CallMemberEventContent with LegacyMembershipData.

pub fn new( application: Application, device_id: OwnedDeviceId, focus_active: ActiveFocus, foci_preferred: Vec<Focus>, created_ts: Option<MilliSecondsSinceUnixEpoch>, expires: Option<Duration>, ) -> CallMemberEventContent

Creates a new CallMemberEventContent with SessionMembershipData.

Arguments

• application - The application that is creating the membership.
• device_id - The device ID of the member.
• focus_active - The active focus state of the member.
• foci_preferred - The preferred focus states of the member.
• created_ts - The timestamp when this state event chain for memberships was created. when updating the event the created_ts should be copied from the previous state. Set to None if this is the initial join event for the session.
• expires - The time after which the event is considered as expired. Defaults to 4 hours.

pub fn new_empty(leave_reason: Option<LeaveReason>) -> CallMemberEventContent

Creates a new Empty CallMemberEventContent representing a left membership.

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

All non expired memberships in this member event.

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

This copies all the memberships and converts them

Arguments

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

pub fn memberships(&self) -> Vec<MembershipData<'_>>

All the memberships for this event. Can only contain multiple elements in the case of legacy m.call.member state events.

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

Set the created_ts 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 duplicate 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 From<CallMemberEventContent> for AnyStateEventContent

fn from(c: CallMemberEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl PartialEq for CallMemberEventContent

fn eq(&self, other: &CallMemberEventContent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PossiblyRedactedStateEventContent for CallMemberEventContent

type StateKey = CallMemberStateKey

The type of the event’s state_key field.

fn event_type(&self) -> StateEventType

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

impl RedactContent for CallMemberEventContent

type Redacted = RedactedCallMemberEventContent

The redacted form of the event’s content.

fn redact( self, _rules: &RedactionRules, ) -> <CallMemberEventContent as RedactContent>::Redacted

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 = CallMemberStateKey

The type of the event’s state_key field.

fn event_type(&self) -> StateEventType

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

impl StaticEventContent for CallMemberEventContent

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

The statically-known part of the event type.

type IsPrefix = False

Whether the statically-known part of the event type is the prefix.

impl StaticStateEventContent for CallMemberEventContent

type PossiblyRedacted = CallMemberEventContent

The possibly redacted form of the event’s content.

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

The type of the event’s unsigned field.

impl JsonCastable<AnyStateEventContent> for CallMemberEventContent

impl JsonCastable<Map<String, Value>> for CallMemberEventContent

impl StructuralPartialEq for CallMemberEventContent