Struct CallInviteEventContent

#[non_exhaustive]
pub struct CallInviteEventContent {
    pub call_id: OwnedVoipId,
    pub party_id: Option<OwnedVoipId>,
    pub lifetime: UInt,
    pub offer: SessionDescription,
    pub version: VoipVersionId,
    pub invitee: Option<OwnedUserId>,
    pub sdp_stream_metadata: BTreeMap<String, StreamMetadata>,
}

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: OwnedVoipId

A unique identifier for the call.

party_id: Option<OwnedVoipId>

Required in VoIP version 1. A unique ID for this session for the duration of 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.

version: VoipVersionId

The version of the VoIP specification this messages adheres to.

invitee: Option<OwnedUserId>

Added in VoIP version 1. The intended target of the invite, if any.

If this is None, the invite is intended for any member of the room, except the sender.

The invite should be ignored if the invitee is set and doesn’t match the user’s ID.

sdp_stream_metadata: BTreeMap<String, StreamMetadata>

Added in VoIP version 1. Metadata describing the streams that will be sent.

This is a map of stream ID to metadata about the stream.

Implementations

impl CallInviteEventContent

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

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

pub fn version_0( call_id: OwnedVoipId, lifetime: UInt, offer: SessionDescription, ) -> Self

Convenience method to create a version 0 CallInviteEventContent with all the required fields.

pub fn version_1( call_id: OwnedVoipId, party_id: OwnedVoipId, lifetime: UInt, offer: SessionDescription, ) -> Self

Convenience method to create a version 1 CallInviteEventContent with all the required fields.

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 TYPE: &'static str = "m.call.invite"

The event type.

impl MessageLikeEventContent for CallInviteEventContent