RemoteConnection

Kotlin |Java

class RemoteConnection

kotlin.Any
↳	android.telecom.RemoteConnection

A connection provided to a ConnectionService by another ConnectionService running in a different process.

Summary

Nested classes
abstract	`Callback` Callback base class for `RemoteConnection`.
	`VideoProvider` `RemoteConnection.VideoProvider` associated with a `RemoteConnection`.

Public methods
Unit	`abort()` Instructs this `RemoteConnection` to abort.
Unit	`addConferenceParticipants(participants: MutableList<Uri!>)` Instructs this `RemoteConnection` to initiate a conference with a list of participants.
Unit	`answer()` Instructs this `Connection#STATE_RINGING` `RemoteConnection` to answer.
Unit	`disconnect()` Instructs this `RemoteConnection` to disconnect.
Uri!	`getAddress()` Obtains the address of this `RemoteConnection`.
Int	`getAddressPresentation()` Obtains the presentation requirements for the address of this `RemoteConnection`.
CharSequence!	`getCallerDisplayName()` Obtains the display name for this `RemoteConnection`'s caller.
Int	`getCallerDisplayNamePresentation()` Obtains the presentation requirements for this `RemoteConnection`'s caller's display name.
RemoteConference!	`getConference()` Obtain the `RemoteConference` that this `RemoteConnection` may be a part of, or `null` if there is no such `RemoteConference`.
MutableList<RemoteConnection!>!	`getConferenceableConnections()` Obtain the `RemoteConnection`s with which this `RemoteConnection` may be successfully asked to create a conference with.
Int	`getConnectionCapabilities()` Obtains the capabilities of this `RemoteConnection`.
Int	`getConnectionProperties()` Obtains the properties of this `RemoteConnection`.
DisconnectCause!	`getDisconnectCause()` Obtains the reason why this `RemoteConnection` may have been disconnected.
Bundle!	`getExtras()` Obtain the extras associated with this `RemoteConnection`.
Int	`getState()` Obtains the state of this `RemoteConnection`.
StatusHints!	`getStatusHints()` Obtains status hints pertaining to this `RemoteConnection`.
RemoteConnection.VideoProvider!	`getVideoProvider()` Obtains the video provider of this `RemoteConnection`.
Int	`getVideoState()` Obtains the video state of this `RemoteConnection`.
Unit	`hold()` Instructs this `RemoteConnection` to go on hold.
Boolean	`isRingbackRequested()` Determines whether this `RemoteConnection` is requesting ringback.
Boolean	`isVoipAudioMode()` Determines if the audio mode of this `RemoteConnection` is VOIP.
Unit	`playDtmfTone(digit: Char)` Instructs this `RemoteConnection` to play a dual-tone multi-frequency signaling (DTMF) tone.
Unit	`postDialContinue(proceed: Boolean)` Instructs this `RemoteConnection` to continue playing a post-dial DTMF string.
Unit	`pullExternalCall()` Instructs this `RemoteConnection` to pull itself to the local device.
Unit	`registerCallback(callback: RemoteConnection.Callback!)` Adds a callback to this `RemoteConnection`.
Unit	`registerCallback(callback: RemoteConnection.Callback!, handler: Handler!)` Adds a callback to this `RemoteConnection`.
Unit	`reject()` Instructs this `Connection#STATE_RINGING` `RemoteConnection` to reject.
Unit	`setCallAudioState(state: CallAudioState!)` Set the audio state of this `RemoteConnection`.
Unit	`stopDtmfTone()` Instructs this `RemoteConnection` to stop any dual-tone multi-frequency signaling (DTMF) tone currently playing.
Unit	`unhold()` Instructs this `Connection#STATE_HOLDING` call to release from hold.
Unit	`unregisterCallback(callback: RemoteConnection.Callback!)` Removes a callback from this `RemoteConnection`.

Public methods

abort

Added in API level 23

fun abort(): Unit

Instructs this RemoteConnection to abort.

addConferenceParticipants

Added in API level 31

fun addConferenceParticipants(participants: MutableList<Uri!>): Unit

Instructs this RemoteConnection to initiate a conference with a list of participants.

Parameters
`participants`	MutableList<Uri!>: with which conference call will be formed. This value cannot be `null`.

answer

Added in API level 23

fun answer(): Unit

Instructs this Connection#STATE_RINGING RemoteConnection to answer.

disconnect

Added in API level 23

fun disconnect(): Unit

Instructs this RemoteConnection to disconnect.

getAddress

Added in API level 23

fun getAddress(): Uri!

Obtains the address of this RemoteConnection.

Return
`Uri!`	The address (e.g., phone number) to which the `RemoteConnection` is currently connected.

getAddressPresentation

Added in API level 23

fun getAddressPresentation(): Int

Obtains the presentation requirements for the address of this RemoteConnection.

Return
`Int`	The presentation requirements for the address. See `TelecomManager` for valid values.

getCallerDisplayName

Added in API level 23

fun getCallerDisplayName(): CharSequence!

Obtains the display name for this RemoteConnection's caller.

Return
`CharSequence!`	The display name for the caller.

getCallerDisplayNamePresentation

Added in API level 23

fun getCallerDisplayNamePresentation(): Int

Obtains the presentation requirements for this RemoteConnection's caller's display name.

Return
`Int`	The presentation requirements for the caller display name. See `TelecomManager` for valid values.

getConference

Added in API level 23

fun getConference(): RemoteConference!

Obtain the RemoteConference that this RemoteConnection may be a part of, or null if there is no such RemoteConference.

Return
`RemoteConference!`	A `RemoteConference` or `null`;

getConferenceableConnections

Added in API level 23

fun getConferenceableConnections(): MutableList<RemoteConnection!>!

Obtain the RemoteConnections with which this RemoteConnection may be successfully asked to create a conference with.

Return
`MutableList<RemoteConnection!>!`	The `RemoteConnection`s with which this `RemoteConnection` may be merged into a `RemoteConference`.

getConnectionCapabilities

Added in API level 23

fun getConnectionCapabilities(): Int

Obtains the capabilities of this RemoteConnection.

Return
`Int`	A bitmask of the capabilities of the `RemoteConnection`, as defined in the `CAPABILITY_*` constants in class `Connection`.

getConnectionProperties

Added in API level 25

fun getConnectionProperties(): Int

Obtains the properties of this RemoteConnection.

Return
`Int`	A bitmask of the properties of the `RemoteConnection`, as defined in the `PROPERTY_*` constants in class `Connection`.

getDisconnectCause

Added in API level 23

fun getDisconnectCause(): DisconnectCause!

Obtains the reason why this RemoteConnection may have been disconnected.

Return
`DisconnectCause!`	For a `Connection#STATE_DISCONNECTED` `RemoteConnection`, the disconnect cause expressed as a code chosen from among those declared in `DisconnectCause`.

getExtras

Added in API level 23

fun getExtras(): Bundle!

Obtain the extras associated with this RemoteConnection.

Return
`Bundle!`	The extras for this connection.

getState

Added in API level 23

fun getState(): Int

Obtains the state of this RemoteConnection.

Return
`Int`	A state value, chosen from the `STATE_*` constants.

getStatusHints

Added in API level 23

fun getStatusHints(): StatusHints!

Obtains status hints pertaining to this RemoteConnection.

Return
`StatusHints!`	The current `StatusHints` of this `RemoteConnection`, or `null` if none have been set.

getVideoProvider

Added in API level 23

fun getVideoProvider(): RemoteConnection.VideoProvider!

Obtains the video provider of this RemoteConnection.

Return
`RemoteConnection.VideoProvider!`	The video provider associated with this `RemoteConnection`.

getVideoState

Added in API level 23

fun getVideoState(): Int

Obtains the video state of this RemoteConnection.

Return
`Int`	The video state of the `RemoteConnection`. See `VideoProfile`.

hold

Added in API level 23

fun hold(): Unit

Instructs this RemoteConnection to go on hold.

isRingbackRequested

Added in API level 23

fun isRingbackRequested(): Boolean

Determines whether this RemoteConnection is requesting ringback.

Return
`Boolean`	Whether the `RemoteConnection` is requesting that the framework play a ringback tone on its behalf.

isVoipAudioMode

Added in API level 23

fun isVoipAudioMode(): Boolean

Determines if the audio mode of this RemoteConnection is VOIP.

Return
`Boolean`	`true` if the `RemoteConnection`'s current audio mode is VOIP.

playDtmfTone

Added in API level 23

fun playDtmfTone(digit: Char): Unit

Instructs this RemoteConnection to play a dual-tone multi-frequency signaling (DTMF) tone. Any other currently playing DTMF tone in the specified call is immediately stopped.

Parameters
`digit`	Char: A character representing the DTMF digit for which to play the tone. This value must be one of `'0'` through `'9'`, `'*'` or `'#'`.

postDialContinue

Added in API level 23

fun postDialContinue(proceed: Boolean): Unit

Instructs this RemoteConnection to continue playing a post-dial DTMF string. A post-dial DTMF string is a string of digits following the first instance of either TelecomManager#DTMF_CHARACTER_WAIT or TelecomManager#DTMF_CHARACTER_PAUSE. These digits are immediately sent as DTMF tones to the recipient as soon as the connection is made. If the DTMF string contains a TelecomManager#DTMF_CHARACTER_PAUSE symbol, this RemoteConnection will temporarily pause playing the tones for a pre-defined period of time. If the DTMF string contains a TelecomManager#DTMF_CHARACTER_WAIT symbol, this RemoteConnection will pause playing the tones and notify callbacks via Callback#onPostDialWait(RemoteConnection, String). At this point, the in-call app should display to the user an indication of this state and an affordance to continue the postdial sequence. When the user decides to continue the postdial sequence, the in-call app should invoke the postDialContinue(boolean) method.

Parameters
`proceed`	Boolean: Whether or not to continue with the post-dial sequence.

pullExternalCall

Added in API level 25

fun pullExternalCall(): Unit

Instructs this RemoteConnection to pull itself to the local device.

See Call#pullExternalCall() for more information.

registerCallback

Added in API level 23

fun registerCallback(callback: RemoteConnection.Callback!): Unit

Adds a callback to this RemoteConnection.

Parameters
`callback`	RemoteConnection.Callback!: A `Callback`.

registerCallback

Added in API level 23

fun registerCallback(
    callback: RemoteConnection.Callback!, 
    handler: Handler!
): Unit

Adds a callback to this RemoteConnection.

Parameters
`callback`	RemoteConnection.Callback!: A `Callback`.
`handler`	Handler!: A `Handler` which command and status changes will be delivered to.

reject

Added in API level 23

fun reject(): Unit

Instructs this Connection#STATE_RINGING RemoteConnection to reject.

setCallAudioState

Added in API level 23

fun setCallAudioState(state: CallAudioState!): Unit

Set the audio state of this RemoteConnection.

Parameters
`state`	CallAudioState!: The audio state of this `RemoteConnection`.

stopDtmfTone

Added in API level 23

fun stopDtmfTone(): Unit

Instructs this RemoteConnection to stop any dual-tone multi-frequency signaling (DTMF) tone currently playing. DTMF tones are played by calling playDtmfTone(char). If no DTMF tone is currently playing, this method will do nothing.

unhold

Added in API level 23

fun unhold(): Unit

Instructs this Connection#STATE_HOLDING call to release from hold.

unregisterCallback

Added in API level 23

fun unregisterCallback(callback: RemoteConnection.Callback!): Unit

Removes a callback from this RemoteConnection.

Parameters
`callback`	RemoteConnection.Callback!: A `Callback`.