ruma_events/call/select_answer.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
//! Types for the [`m.call.select_answer`] event.
//!
//! [`m.call.select_answer`]: https://spec.matrix.org/latest/client-server-api/#mcallselect_answer
use ruma_common::{OwnedVoipId, VoipVersionId};
use ruma_macros::EventContent;
use serde::{Deserialize, Serialize};
/// **Added in VoIP version 1.** The content of an `m.call.select_answer` event.
///
/// This event is sent by the caller when it has chosen an answer.
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
#[ruma_event(type = "m.call.select_answer", kind = MessageLike)]
pub struct CallSelectAnswerEventContent {
/// The ID of the call this event relates to.
pub call_id: OwnedVoipId,
/// A unique ID for this session for the duration of the call.
///
/// Must be the same as the one sent by the previous invite from this session.
pub party_id: OwnedVoipId,
/// The party ID of the selected answer to the previously sent invite.
pub selected_party_id: OwnedVoipId,
/// The version of the VoIP specification this messages adheres to.
///
/// Cannot be older than `VoipVersionId::V1`.
pub version: VoipVersionId,
}
impl CallSelectAnswerEventContent {
/// Creates a `CallSelectAnswerEventContent` with the given call ID, VoIP version, party ID and
/// selected party ID.
pub fn new(
call_id: OwnedVoipId,
party_id: OwnedVoipId,
selected_party_id: OwnedVoipId,
version: VoipVersionId,
) -> Self {
Self { call_id, party_id, selected_party_id, version }
}
/// Convenience method to create a version 1 `CallSelectAnswerEventContent` with all the
/// required fields.
pub fn version_1(
call_id: OwnedVoipId,
party_id: OwnedVoipId,
selected_party_id: OwnedVoipId,
) -> Self {
Self::new(call_id, party_id, selected_party_id, VoipVersionId::V1)
}
}