platform_telecom_api_common_model/com.tomtom.ivi.platform.telecom.api.common.model/Call

Call

data class Call(val id: CallId, val state: CallState, val capabilities: EnumSet<CallCapability>, val creationTime: Instant, val activationTime: Instant?, val phoneNumber: String, val displayName: String, val disconnectedCause: DisconnectCause?, val phoneAccountId: String) : Parcelable

Represents a phone call.

Constructors

Call

fun Call(id: CallId, state: CallState, capabilities: EnumSet<CallCapability>, creationTime: Instant, activationTime: Instant?, phoneNumber: String, displayName: String, disconnectedCause: DisconnectCause?, phoneAccountId: String)

Properties

activationTime

val activationTime: Instant?

An Instant object representing the time the call was first made CallState.ACTIVE.

capabilities

val capabilities: EnumSet<CallCapability>

Describes operations that can be performed on the call.

creationTime

val creationTime: Instant

An Instant object representing the time the call was created.

disconnectedCause

val disconnectedCause: DisconnectCause?

Indicates the reason the call is in the CallState.DISCONNECTED state. It is null if the call is not in that state.

displayName

val displayName: String

The name to display for the caller. Will be empty if unavailable.

val id: CallId

The identifier that uniquely identifies a call.

phoneAccountId

val phoneAccountId: String

The id of the phone account from which this call originates. It corresponds to the ID returned by the PhoneAccountHandle#getId() Android Telecom API.

phoneNumber

val phoneNumber: String

Phone number of the call in the format provided by Android.

state

val state: CallState

The state of the call.

Functions

toString

open override fun toString(): String

phoneNumber and displayName are masked when the Call is printed.

withState

fun withState(value: CallState): Call

Provides a new instance of the call with the new CallState defined in value.

fun withState(callState: CallState, disconnectCause: DisconnectCause?): Call

Provides a new instance of the call with the new CallState defined in callState including the DisconnectCause defined in disconnectCause.

Inherited functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Extensions

callFailed

val Call.callFailed: Boolean

Indicates if a Call has failed, which happens when the Call.state is in CallState.DISCONNECTED and the Call.disconnectedCause is either DisconnectCause.RESTRICTED, DisconnectCause.UNKNOWN or DisconnectCause.BUSY.

canBePutOnHold

val Call.canBePutOnHold: Boolean

Indicates if a Call has the capability to be put on hold, which happens when the Call.capabilities have the CallCapability.HOLD.

canHangup

val Call.canHangup: Boolean

Indicates if a Call can be hanged up, which happens when the Call is in the CallState.ACTIVE, CallState.DIALING, CallState.CONNECTING, CallState.ANSWERING or CallState.HOLDING state.

canMute

val Call.canMute: Boolean

Indicates if a Call can be muted, which happens when the Call is in the CallState.ACTIVE or CallState.HOLDING state.

capableOfMute

val Call.capableOfMute: Boolean

Indicates if a Call has the capability to be muted, which happens when the Call.capabilities have the CallCapability.MUTE.

isInProgress

val Call.isInProgress: Boolean

Indicates if a Call is in progress, which happens when the Call either isOngoing or isOnHold.

isOngoing

val Call.isOngoing: Boolean

Indicates if a Call is currently ongoing, which happens when the Call is in the CallState.ACTIVE, CallState.DIALING, CallState.CONNECTING or CallState.ANSWERING state.

isOnHold

val Call.isOnHold: Boolean

Indicates if a Call is currently on hold, which happens when the Call is in the CallState.HOLDING state.

isRinging

val Call.isRinging: Boolean

Indicates if a Call is currently ringing, which happens when the Call is in the CallState.RINGING state.