ruma_events/call/
invite.rs

Help
1//! Types for the [`m.call.invite`] event.
2//!
3//! [`m.call.invite`]: https://spec.matrix.org/latest/client-server-api/#mcallinvite
4
5use std::collections::BTreeMap;
6
7use js_int::UInt;
8use ruma_common::{OwnedUserId, OwnedVoipId, VoipVersionId};
9use ruma_macros::EventContent;
10use serde::{Deserialize, Serialize};
11
12#[cfg(feature = "unstable-msc2747")]
13use super::CallCapabilities;
14use super::{SessionDescription, StreamMetadata};
15
16/// The content of an `m.call.invite` event.
17///
18/// This event is sent by the caller when they wish to establish a call.
19#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
20#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
21#[ruma_event(type = "m.call.invite", kind = MessageLike)]
22pub struct CallInviteEventContent {
23    /// A unique identifier for the call.
24    pub call_id: OwnedVoipId,
25
26    /// **Required in VoIP version 1.** A unique ID for this session for the duration of the call.
27    #[serde(skip_serializing_if = "Option::is_none")]
28    pub party_id: Option<OwnedVoipId>,
29
30    /// The time in milliseconds that the invite is valid for.
31    ///
32    /// Once the invite age exceeds this value, clients should discard it. They should also no
33    /// longer show the call as awaiting an answer in the UI.
34    pub lifetime: UInt,
35
36    /// The session description object.
37    pub offer: SessionDescription,
38
39    /// The version of the VoIP specification this messages adheres to.
40    pub version: VoipVersionId,
41
42    #[cfg(feature = "unstable-msc2747")]
43    /// The VoIP capabilities of the client.
44    #[serde(default, skip_serializing_if = "CallCapabilities::is_default")]
45    pub capabilities: CallCapabilities,
46
47    /// **Added in VoIP version 1.** The intended target of the invite, if any.
48    ///
49    /// If this is `None`, the invite is intended for any member of the room, except the sender.
50    ///
51    /// The invite should be ignored if the invitee is set and doesn't match the user's ID.
52    #[serde(skip_serializing_if = "Option::is_none")]
53    pub invitee: Option<OwnedUserId>,
54
55    /// **Added in VoIP version 1.** Metadata describing the streams that will be sent.
56    ///
57    /// This is a map of stream ID to metadata about the stream.
58    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
59    pub sdp_stream_metadata: BTreeMap<String, StreamMetadata>,
60}
61
62impl CallInviteEventContent {
63    /// Creates a new `CallInviteEventContent` with the given call ID, lifetime, offer and VoIP
64    /// version.
65    pub fn new(
66        call_id: OwnedVoipId,
67        lifetime: UInt,
68        offer: SessionDescription,
69        version: VoipVersionId,
70    ) -> Self {
71        Self {
72            call_id,
73            party_id: None,
74            lifetime,
75            offer,
76            version,
77            #[cfg(feature = "unstable-msc2747")]
78            capabilities: Default::default(),
79            invitee: None,
80            sdp_stream_metadata: Default::default(),
81        }
82    }
83
84    /// Convenience method to create a version 0 `CallInviteEventContent` with all the required
85    /// fields.
86    pub fn version_0(call_id: OwnedVoipId, lifetime: UInt, offer: SessionDescription) -> Self {
87        Self::new(call_id, lifetime, offer, VoipVersionId::V0)
88    }
89
90    /// Convenience method to create a version 1 `CallInviteEventContent` with all the required
91    /// fields.
92    pub fn version_1(
93        call_id: OwnedVoipId,
94        party_id: OwnedVoipId,
95        lifetime: UInt,
96        offer: SessionDescription,
97    ) -> Self {
98        Self {
99            call_id,
100            party_id: Some(party_id),
101            lifetime,
102            offer,
103            version: VoipVersionId::V1,
104            #[cfg(feature = "unstable-msc2747")]
105            capabilities: Default::default(),
106            invitee: None,
107            sdp_stream_metadata: Default::default(),
108        }
109    }
110}
ruma_events/call/invite.rs

ruma_events/call/
invite.rs
