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

CallReplacesContent

@JsonClass(generateAdapter = true)

data class CallReplacesContent( @Json(name = "call_id") val callId: String, @Json(name = "party_id") val partyId: String? = null, @Json(name = "replacement_id") val replacementId: String? = null, @Json(name = "target_room") val targetRoomId: String? = null, @Json(name = "target_user") val targetUser: CallReplacesContent.TargetUser? = null, @Json(name = "create_call") val createCall: String? = null, @Json(name = "await_call") val awaitCall: String? = null, @Json(name = "version") val version: String?) : CallSignalingContent

This event is sent to signal the intent of a participant in a call to replace the call with another, such that the other participant ends up in a call with a new user.

Constructors

CallReplacesContent

fun CallReplacesContent( @Json(name = "call_id") callId: String, @Json(name = "party_id") partyId: String? = null, @Json(name = "replacement_id") replacementId: String? = null, @Json(name = "target_room") targetRoomId: String? = null, @Json(name = "target_user") targetUser: CallReplacesContent.TargetUser? = null, @Json(name = "create_call") createCall: String? = null, @Json(name = "await_call") awaitCall: String? = null, @Json(name = "version") version: String?)

Types

TargetUser

@JsonClass(generateAdapter = true)

data class TargetUser( @Json(name = "id") val id: String, @Json(name = "display_name") val displayName: String?, @Json(name = "avatar_url") val avatarUrl: String?)

Properties

awaitCall

val awaitCall: String? = null

If specified, gives the call ID that the transferee's client should wait for. Mutually exclusive with create_call.

callId

open override val callId: String

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

createCall

val createCall: String? = null

If specified, gives the call ID for the transferee's client to use when placing the replacement call. Mutually exclusive with await_call

partyId

open override val partyId: String? = null

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

replacementId

val replacementId: String? = null

An identifier for the call replacement itself, generated by the transferor.

targetRoomId

val targetRoomId: String? = null

Optional. If specified, the transferee client waits for an invite to this room and joins it (possibly waiting for user confirmation) and then continues the transfer in this room. If absent, the transferee contacts the Matrix User ID given in the target_user field in a room of its choosing.

targetUser

val targetUser: CallReplacesContent.TargetUser? = null

An object giving information about the transfer target.

version

open override val version: String?

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