Struct matrix_sdk_base::ruma::events::call::member::Membership

#[non_exhaustive]
pub struct Membership {
    pub application: Application,
    pub device_id: String,
    pub expires: Duration,
    pub created_ts: Option<MilliSecondsSinceUnixEpoch>,
    pub foci_active: Vec<Focus>,
    pub membership_id: String,
}

Available on crate feature unstable-msc3401 only.

A membership describes one of the sessions this user currently partakes.

The application defines the type of the session.

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.

application: Application

The type of the matrixRTC session the membership belongs to.

e.g. call, spacial, document…

device_id: String

The device id of this membership.

The same user can join with their phone/computer.

expires: Duration

The duration in milliseconds relative to the time this membership joined during which the membership is valid.

The time a member has joined is defined as: MIN(content.created_ts, event.origin_server_ts)

created_ts: Option<MilliSecondsSinceUnixEpoch>

Stores a copy of the origin_server_ts of the initial session event.

If the membership is updated this field will be used to track to original origin_server_ts.

foci_active: Vec<Focus>

A list of the foci in use for this membership.

membership_id: String

The id of the membership.

This is required to guarantee uniqueness of the event. Sending the same state event twice to synapse makes the HS drop the second one and return 200.

Implementations

impl Membership

pub fn is_room_call(&self) -> bool

The application of the membership is “m.call” and the scope is “m.room”.

pub fn is_call(&self) -> bool

The application of the membership is “m.call”.

pub fn is_expired( &self, origin_server_ts: Option<MilliSecondsSinceUnixEpoch> ) -> bool

Checks if the event is expired.

Defaults to using created_ts of the Membership. If no origin_server_ts is provided and the event does not contain created_ts the event will be considered as not expired. In this case, a warning will be logged.

Arguments

• origin_server_ts - a fallback if created_ts is not present

Trait Implementations

impl Clone for Membership

fn clone(&self) -> Membership

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Membership

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Membership

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MembershipInit> for Membership

fn from(init: MembershipInit) -> Membership

Converts to this type from the input type.

impl Serialize for Membership

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.