Struct RtcNotificationEventContent

#[non_exhaustive]
pub struct RtcNotificationEventContent {
    pub sender_ts: MilliSecondsSinceUnixEpoch,
    pub lifetime: Duration,
    pub mentions: Option<Mentions>,
    pub relates_to: Option<Reference>,
    pub notification_type: NotificationType,
}

The content of an m.rtc.notification event.

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.

sender_ts: MilliSecondsSinceUnixEpoch

Local timestamp observed by the sender device.

Used with lifetime to determine validity; receivers SHOULD compare with origin_server_ts and prefer it if the difference is large.

lifetime: Duration

Relative time from sender_ts during which the notification is considered valid.

mentions: Option<Mentions>

Intentional mentions determining who should be notified.

relates_to: Option<Reference>

Optional reference to the related m.rtc.member event.

notification_type: NotificationType

How this notification should notify the receiver.

Implementations

impl RtcNotificationEventContent

pub fn new( sender_ts: MilliSecondsSinceUnixEpoch, lifetime: Duration, notification_type: NotificationType, ) -> RtcNotificationEventContent

Creates a new RtcNotificationEventContent with the given configuration.

pub fn expiration_ts( &self, origin_server_ts: MilliSecondsSinceUnixEpoch, max_sender_ts_offset: Option<u32>, ) -> MilliSecondsSinceUnixEpoch

Calculates the timestamp at which this notification is considered invalid. This calculation is based on MSC4075 and tries to use the sender_ts as the starting point and the lifetime as the duration for which the notification is valid.

The sender_ts cannot be trusted since it is a generated value by the sending client. To mitigate issue because of misconfigured client clocks, the MSC requires that the origin_server_ts is used as the starting point if the difference is large.

Arguments:

• max_sender_ts_offset is the maximum allowed offset between the two timestamps. (default 20s)
• origin_server_ts has to be set to the origin_server_ts from the event containing this event content.

Examples

To start a timer until this client should stop ringing for this notification: let duration_ring = MilliSecondsSinceUnixEpoch::now().saturated_sub(content.expiration_ts(event. origin_server_ts(), None));

Trait Implementations

impl Clone for RtcNotificationEventContent

fn clone(&self) -> RtcNotificationEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RtcNotificationEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RtcNotificationEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RtcNotificationEventContent> for AnyMessageLikeEventContent

fn from(c: RtcNotificationEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl MessageLikeEventContent for RtcNotificationEventContent

fn event_type(&self) -> MessageLikeEventType

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

impl RedactContent for RtcNotificationEventContent

type Redacted = RedactedRtcNotificationEventContent

The redacted form of the event’s content.

fn redact(self, _rules: &RedactionRules) -> RedactedRtcNotificationEventContent

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

impl Serialize for RtcNotificationEventContent

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 StaticEventContent for RtcNotificationEventContent

const TYPE: &'static str = "m.rtc.notification"

The statically-known part of the event type.

type IsPrefix = False

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

impl JsonCastable<AnyMessageLikeEventContent> for RtcNotificationEventContent

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

impl JsonCastable<RedactedRtcNotificationEventContent> for RtcNotificationEventContent