Struct ruma_common::events::call::invite::CallInviteEventContent

#[non_exhaustive]
pub struct CallInviteEventContent {
    pub call_id: String,
    pub lifetime: UInt,
    pub offer: SessionDescription,
    pub version: UInt,
}

The content of an m.call.invite event.

This event is sent by the caller when they wish to establish a call.

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.

call_id: String

A unique identifier for the call.

lifetime: UInt

The time in milliseconds that the invite is valid for.

Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.

offer: SessionDescription

The session description object.

The session description type must be offer.

version: UInt

The version of the VoIP specification this messages adheres to.

Implementations

impl CallInviteEventContent

pub fn new(
    call_id: String,
    lifetime: UInt,
    offer: SessionDescription,
    version: UInt
) -> Self

Creates a new InviteEventContent with the given call ID, lifetime and VoIP version.

Trait Implementations

impl Clone for CallInviteEventContent

fn clone(&self) -> CallInviteEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallInviteEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallInviteEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for CallInviteEventContent

type EventType = MessageLikeEventType

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

fn event_type(&self) -> Self::EventType

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

impl From<CallInviteEventContent> for AnyMessageLikeEventContent

fn from(c: CallInviteEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for CallInviteEventContent

type Redacted = RedactedCallInviteEventContent

The redacted form of the event’s content.

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

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

impl Serialize for CallInviteEventContent

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

Serialize this value into the given Serde serializer.

impl StaticEventContent for CallInviteEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::MessageLike{redacted: false,}

The event’s “kind”.

const TYPE: &'static str = "m.call.invite"

The event type.