Added in API level 23

Summary: Nested Classes | Methods | Inherited Methods

RemoteConnection

Kotlin |Java

public final class RemoteConnection
extends Object

java.lang.Object
↳	android.telecom.RemoteConnection

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

See also:

Summary

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

Public methods
`void`	`abort()` Instructs this `RemoteConnection` to abort.
`void`	`addConferenceParticipants(List<Uri> participants)` Instructs this `RemoteConnection` to initiate a conference with a list of participants.
`void`	`answer()` Instructs this `Connection.STATE_RINGING` `RemoteConnection` to answer.
`void`	`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`.
`List<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`.
`void`	`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.
`void`	`playDtmfTone(char digit)` Instructs this `RemoteConnection` to play a dual-tone multi-frequency signaling (DTMF) tone.
`void`	`postDialContinue(boolean proceed)` Instructs this `RemoteConnection` to continue playing a post-dial DTMF string.
`void`	`pullExternalCall()` Instructs this `RemoteConnection` to pull itself to the local device.
`void`	`registerCallback(RemoteConnection.Callback callback)` Adds a callback to this `RemoteConnection`.
`void`	`registerCallback(RemoteConnection.Callback callback, Handler handler)` Adds a callback to this `RemoteConnection`.
`void`	`reject()` Instructs this `Connection.STATE_RINGING` `RemoteConnection` to reject.
`void`	`setCallAudioState(CallAudioState state)` Set the audio state of this `RemoteConnection`.
`void`	`stopDtmfTone()` Instructs this `RemoteConnection` to stop any dual-tone multi-frequency signaling (DTMF) tone currently playing.
`void`	`unhold()` Instructs this `Connection.STATE_HOLDING` call to release from hold.
`void`	`unregisterCallback(RemoteConnection.Callback callback)` Removes a callback from this `RemoteConnection`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

abort

Added in API level 23

public void abort ()

Instructs this RemoteConnection to abort.

addConferenceParticipants

Added in API level 31

public void addConferenceParticipants (List<Uri> participants)

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

Parameters
`participants`	`List`: with which conference call will be formed. This value cannot be `null`.

answer

Added in API level 23

public void answer ()

Instructs this Connection.STATE_RINGING RemoteConnection to answer.

disconnect

Added in API level 23

public void disconnect ()

Instructs this RemoteConnection to disconnect.

getAddress

Added in API level 23

public Uri getAddress ()

Obtains the address of this RemoteConnection.

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

getAddressPresentation

Added in API level 23

public int getAddressPresentation ()

Obtains the presentation requirements for the address of this RemoteConnection.

Returns
`int`	The presentation requirements for the address. See `TelecomManager` for valid values.

getCallerDisplayName

Added in API level 23

public CharSequence getCallerDisplayName ()

Obtains the display name for this RemoteConnection's caller.

Returns
`CharSequence`	The display name for the caller.

getCallerDisplayNamePresentation

Added in API level 23

public int getCallerDisplayNamePresentation ()

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

Returns
`int`	The presentation requirements for the caller display name. See `TelecomManager` for valid values.

getConference

Added in API level 23

public RemoteConference getConference ()

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

Returns
`RemoteConference`	A `RemoteConference` or `null`;

getConferenceableConnections

Added in API level 23

public List<RemoteConnection> getConferenceableConnections ()

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

Returns
`List<RemoteConnection>`	The `RemoteConnection`s with which this `RemoteConnection` may be merged into a `RemoteConference`.

getConnectionCapabilities

Added in API level 23

public int getConnectionCapabilities ()

Obtains the capabilities of this RemoteConnection.

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

getConnectionProperties

Added in API level 25

public int getConnectionProperties ()

Obtains the properties of this RemoteConnection.

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

getDisconnectCause

Added in API level 23

public DisconnectCause getDisconnectCause ()

Obtains the reason why this RemoteConnection may have been disconnected.

Returns
`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

public Bundle getExtras ()

Obtain the extras associated with this RemoteConnection.

Returns
`Bundle`	The extras for this connection.

getState

Added in API level 23

public int getState ()

Obtains the state of this RemoteConnection.

Returns
`int`	A state value, chosen from the `STATE_*` constants.

getStatusHints

Added in API level 23

public StatusHints getStatusHints ()

Obtains status hints pertaining to this RemoteConnection.

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

getVideoProvider

Added in API level 23

public RemoteConnection.VideoProvider getVideoProvider ()

Obtains the video provider of this RemoteConnection.

Returns
`RemoteConnection.VideoProvider`	The video provider associated with this `RemoteConnection`.

getVideoState

Added in API level 23

public int getVideoState ()

Obtains the video state of this RemoteConnection.

Returns
`int`	The video state of the `RemoteConnection`. See `VideoProfile`.

hold

Added in API level 23

public void hold ()

Instructs this RemoteConnection to go on hold.

isRingbackRequested

Added in API level 23

public boolean isRingbackRequested ()

Determines whether this RemoteConnection is requesting ringback.

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

isVoipAudioMode

Added in API level 23

public boolean isVoipAudioMode ()

Determines if the audio mode of this RemoteConnection is VOIP.

Returns
`boolean`	`true` if the `RemoteConnection`'s current audio mode is VOIP.

playDtmfTone

Added in API level 23

public void playDtmfTone (char digit)

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

public void postDialContinue (boolean proceed)

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

public void pullExternalCall ()

Instructs this RemoteConnection to pull itself to the local device.

See Call.pullExternalCall() for more information.

registerCallback

Added in API level 23

public void registerCallback (RemoteConnection.Callback callback)

Adds a callback to this RemoteConnection.

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

registerCallback

Added in API level 23

public void registerCallback (RemoteConnection.Callback callback, 
                Handler handler)

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

public void reject ()

Instructs this Connection.STATE_RINGING RemoteConnection to reject.

setCallAudioState

Added in API level 23

public void setCallAudioState (CallAudioState state)

Set the audio state of this RemoteConnection.

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

stopDtmfTone

Added in API level 23

public void stopDtmfTone ()

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

public void unhold ()

Instructs this Connection.STATE_HOLDING call to release from hold.

unregisterCallback

Added in API level 23

public void unregisterCallback (RemoteConnection.Callback callback)

Removes a callback from this RemoteConnection.

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

RemoteConnection

Summary

Nested classes

Public methods

Inherited methods

Public methods

abort

addConferenceParticipants

answer

disconnect

getAddress

getAddressPresentation

getCallerDisplayName

getCallerDisplayNamePresentation

getConference

getConferenceableConnections

getConnectionCapabilities

getConnectionProperties

getDisconnectCause

getExtras

getState

getStatusHints

getVideoProvider

getVideoState

hold

isRingbackRequested

isVoipAudioMode

playDtmfTone

postDialContinue

pullExternalCall

registerCallback

registerCallback

reject

setCallAudioState

stopDtmfTone

unhold

unregisterCallback