Struct ruma::events::call::hangup::CallHangupEventContent

pub struct CallHangupEventContent {
    pub call_id: OwnedVoipId,
    pub party_id: Option<OwnedVoipId>,
    pub version: VoipVersionId,
    pub reason: Option<Reason>,
}

Available on crate feature events only.

The content of an m.call.hangup event.

Sent by either party to signal their termination of the call.

In VoIP version 0, this can be sent either once the call has been established or before to abort the call.

With the unstable-msc2746 feature, and if the call is using VoIP version 1, this should only be sent by the caller after sending the invite or by the callee after answering the invite. To reject an invite, send an m.call.reject event.

Fields

call_id: OwnedVoipId

A unique identifier for the call.

party_id: Option<OwnedVoipId>

Available on crate feature unstable-msc2746 only.

Required in VoIP version 1. A unique ID for this session for the duration of the call.

Must be the same as the one sent by the previous invite or answer from this session.

version: VoipVersionId

The version of the VoIP specification this messages adheres to.

reason: Option<Reason>

Optional error reason for the hangup.

With the unstable-msc2746 feature, this field defaults to Some(Reason::UserHangup).

Implementations

impl CallHangupEventContent

pub fn new(
    call_id: OwnedVoipId,
    version: VoipVersionId
) -> CallHangupEventContent

Creates a new CallHangupEventContent with the given call ID and VoIP version.

pub fn version_0(call_id: OwnedVoipId) -> CallHangupEventContent

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

pub fn version_1(
    call_id: OwnedVoipId,
    party_id: OwnedVoipId,
    reason: Reason
) -> CallHangupEventContent

Available on crate feature unstable-msc2746 only.

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

Trait Implementations

impl Clone for CallHangupEventContent

fn clone(&self) -> CallHangupEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallHangupEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallHangupEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for CallHangupEventContent

type EventType = MessageLikeEventType

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

fn event_type(&self) -> <CallHangupEventContent as EventContent>::EventType

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

impl From<CallHangupEventContent> for AnyMessageLikeEventContent

fn from(c: CallHangupEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl RedactContent for CallHangupEventContent

type Redacted = RedactedCallHangupEventContent

The redacted form of the event’s content.

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

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

impl Serialize for CallHangupEventContent

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 CallHangupEventContent

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

The event’s “kind”.

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

The event type.

impl MessageLikeEventContent for CallHangupEventContent