matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.call/CallHangupContent

CallHangupContent

@JsonClass(generateAdapter = true)

data class CallHangupContent( @Json(name = "call_id") val callId: String, @Json(name = "party_id") val partyId: String? = null, @Json(name = "version") val version: String?, @Json(name = "reason") val reason: EndCallReason? = null) : CallSignalingContent

Sent by either party to signal their termination of the call. This can be sent either once the call has been established or before to abort the call.

Constructors

CallHangupContent

fun CallHangupContent( @Json(name = "call_id") callId: String, @Json(name = "party_id") partyId: String? = null, @Json(name = "version") version: String?, @Json(name = "reason") reason: EndCallReason? = null)

Properties

callId

open override val callId: String

Required. The ID of the call this event relates to.

partyId

open override val partyId: String? = null

Required. ID to let user identify remote echo of their own events

reason

val reason: EndCallReason? = null

Optional error reason for the hangup. This should not be provided when the user naturally ends or rejects the call. When there was an error in the call negotiation, this should be ice_failed for when ICE negotiation fails or invite_timeout for when the other party did not answer in time. One of: "ice_failed", "invite_timeout"

version

open override val version: String?

Required. The version of the VoIP specification this message adheres to.