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

Package-level declarations

This library contains data representation of calls information and status of synchronization with Bluetooth devices.

The Call and CallState classes define the data belonging to a call.

The PhoneBookSynchronizationStatus enum class contains the different status of synchronization with Bluetooth devices.

Types

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.

CallCapability

enum CallCapability : Enum<CallCapability>

The possible capabilities for a Call.

CallId

data class CallId(val value: Long) : Parcelable

Represents an identifier that uniquely identifies a call.

CallState

enum CallState : Enum<CallState>

The possible call states.

DtmfTone

enum DtmfTone : Enum<DtmfTone> , Parcelable

The possible DTMF tones.

PhoneBookSynchronizationStatus

enum PhoneBookSynchronizationStatus : Enum<PhoneBookSynchronizationStatus>

Status of synchronization with Bluetooth devices.

PhoneUri

data class PhoneUri(val uri: Uri) : Parcelable

Represents a phone URI.

SipUri

data class SipUri(val uri: Uri) : Parcelable

Represents a SIP URI.

Properties

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.