Conference

CONNECT_TIME_NOT_SPECIFIED

static val CONNECT_TIME_NOT_SPECIFIED: Long

Used to indicate that the conference connection time is not specified. If not specified, Telecom will set the connect time.

Value: 0L

Conference

Conference(phoneAccount: PhoneAccountHandle!)

Constructs a new Conference with a mandatory PhoneAccountHandle

addConnection

fun addConnection(connection: Connection!): Boolean

Adds the specified connection as a child of this conference.

createFailedConference

open static fun createFailedConference(
    disconnectCause: DisconnectCause, 
    phoneAccount: PhoneAccountHandle
): Conference

Return a Conference which represents a failed conference attempt. The returned Conference will have a android.telecom.DisconnectCause and as specified, and a getState() of STATE_DISCONNECTED.

The returned Conference can be assumed to destroy() itself when appropriate, so users of this method need not maintain a reference to its return value to destroy it.

destroy

fun destroy(): Unit

Tears down the conference object and any of its current connections.

getCallAudioState

fun getCallAudioState(): CallAudioState!

Deprecated: Use getCurrentCallEndpoint(), onAvailableCallEndpointsChanged(java.util.List) and onMuteStateChanged(boolean) instead.

getConferenceableConnections

fun getConferenceableConnections(): MutableList<Connection!>!

Returns the connections with which this connection can be conferenced.

getConnectionCapabilities

fun getConnectionCapabilities(): Int

Returns the capabilities of the conference. See CAPABILITY_* constants in class Connection for valid values.

getConnectionProperties

fun getConnectionProperties(): Int

Returns the properties of the conference. See PROPERTY_* constants in class Connection for valid values.

getConnectionStartElapsedRealtimeMillis

fun getConnectionStartElapsedRealtimeMillis(): Long

Retrieves the connection start time of the Conference, if specified. A value of CONNECT_TIME_NOT_SPECIFIED indicates that Telecom should determine the start time of the conference.

This is based on the value of SystemClock#elapsedRealtime() to ensure that it is not impacted by wall clock changes (user initiated, network initiated, time zone change, etc).

Note: This is only exposed for use by the Telephony framework which needs it to copy conference start times among conference participants. It is exposed as a system API since it has no general use other than to the Telephony framework.
Value is a non-negative timestamp in the android.os.SystemClock#elapsedRealtime() time base.

getConnectionTime

fun getConnectionTime(): Long

Retrieves the connection start time of the Conference, if specified. A value of CONNECT_TIME_NOT_SPECIFIED indicates that Telecom should determine the start time of the conference.

getConnections

fun getConnections(): MutableList<Connection!>!

Returns the list of connections currently associated with the conference call.

getCurrentCallEndpoint

fun getCurrentCallEndpoint(): CallEndpoint

Obtains the current CallEndpoint.

getDisconnectCause

fun getDisconnectCause(): DisconnectCause!

getExtras

fun getExtras(): Bundle!

Returns the extras associated with this conference.

Extras should be updated using putExtras(android.os.Bundle) and removeExtras(java.util.List).

Telecom or an InCallService can also update the extras via android.telecom.Call#putExtras(Bundle), and Call#removeExtras(List).

The conference is notified of changes to the extras made by Telecom or an InCallService by onExtrasChanged(android.os.Bundle).

getPhoneAccountHandle

fun getPhoneAccountHandle(): PhoneAccountHandle!

Returns the PhoneAccountHandle the conference call is being placed through.

getState

fun getState(): Int

Gets the state of the conference call. See Connection for valid values.

getStatusHints

fun getStatusHints(): StatusHints!

getVideoProvider

open fun getVideoProvider(): Connection.VideoProvider!

Returns VideoProvider of the primary call. This can be null.

getVideoState

open fun getVideoState(): Int

Returns video state of the primary call.

isRingbackRequested

fun isRingbackRequested(): Boolean

Returns whether this conference is requesting that the system play a ringback tone on its behalf. A ringback tone may be played when an outgoing conference is in the process of connecting to give the user an audible indication of that process.

onAddConferenceParticipants

open fun onAddConferenceParticipants(participants: MutableList<Uri!>): Unit

Notifies the Conference of a request to add a new participants to the conference call

onAnswer

open fun onAnswer(videoState: Int): Unit

Notifies this Conference, which is in STATE_RINGING, of a request to accept. For managed ConnectionServices, this will be called when the user answers a call via the default dialer's InCallService.

onAvailableCallEndpointsChanged

open fun onAvailableCallEndpointsChanged(availableEndpoints: MutableList<CallEndpoint!>): Unit

Notifies the Conference that the available call endpoints have been changed.

onCallAudioStateChanged

open fun onCallAudioStateChanged(state: CallAudioState!): Unit

Deprecated: Use onCallEndpointChanged(android.telecom.CallEndpoint), onAvailableCallEndpointsChanged(java.util.List) and onMuteStateChanged(boolean) instead.

Notifies the Conference that the getCallAudioState() property has a new value.

onCallEndpointChanged

open fun onCallEndpointChanged(callEndpoint: CallEndpoint): Unit

Notifies the Conference that the audio endpoint has been changed.

onConnectionAdded

open fun onConnectionAdded(connection: Connection!): Unit

Notifies the Conference that a Connection has been added to it.

onDisconnect

open fun onDisconnect(): Unit

Notifies the Conference when the Conference and all it's Connections should be disconnected.

onExtrasChanged

open fun onExtrasChanged(extras: Bundle!): Unit

Notifies this Conference of a change to the extras made outside the ConnectionService.

These extras changes can originate from Telecom itself, or from an InCallService via android.telecom.Call#putExtras(Bundle), and Call#removeExtras(List).

onHold

open fun onHold(): Unit

Notifies the Conference when it should be put on hold.

onMerge

open fun onMerge(connection: Connection!): Unit

Notifies the Conference when the specified Connection should merged with the conference call.

onMerge

open fun onMerge(): Unit

Notifies the Conference when the child calls should be merged. Only invoked if the conference contains the capability Connection#CAPABILITY_MERGE_CONFERENCE.

onMuteStateChanged

open fun onMuteStateChanged(isMuted: Boolean): Unit

Notifies the Conference that its audio mute state has been changed.

onPlayDtmfTone

open fun onPlayDtmfTone(c: Char): Unit

Notifies the Conference of a request to play a DTMF tone.

onReject

open fun onReject(): Unit

Notifies this Conference, which is in STATE_RINGING, of a request to reject. For managed ConnectionServices, this will be called when the user rejects a call via the default dialer's InCallService.

onSeparate

open fun onSeparate(connection: Connection!): Unit

Notifies the Conference when the specified Connection should be separated from the conference call.

onStopDtmfTone

open fun onStopDtmfTone(): Unit

Notifies the Conference of a request to stop any currently playing DTMF tones.

onSwap

open fun onSwap(): Unit

Notifies the Conference when the child calls should be swapped. Only invoked if the conference contains the capability Connection#CAPABILITY_SWAP_CONFERENCE.

onUnhold

open fun onUnhold(): Unit

Notifies the Conference when it should be moved from a held to active state.

putExtras

fun putExtras(extras: Bundle): Unit

Adds some extras to this Conference. Existing keys are replaced and new ones are added.

No assumptions should be made as to how an In-Call UI or service will handle these extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.

removeConnection

fun removeConnection(connection: Connection!): Unit

Removes the specified connection as a child of this conference.

removeExtras

fun removeExtras(keys: MutableList<String!>!): Unit

Removes extras from this Conference.

removeExtras

fun removeExtras(vararg keys: String!): Unit

Removes extras from this Conference.

sendConferenceEvent

open fun sendConferenceEvent(
    event: String, 
    extras: Bundle?
): Unit

Sends an event associated with this Conference with associated event extras to the InCallService.

Connection events are used to communicate point in time information from a ConnectionService to an InCallService implementation. An example of a custom connection event includes notifying the UI when a WIFI call has been handed over to LTE, which the InCall UI might use to inform the user that billing charges may apply. The Android Telephony framework will send the Connection#EVENT_MERGE_COMPLETE connection event when a call to Call#mergeConference() has completed successfully.

Events are exposed to InCallService implementations via Call.Callback#onConnectionEvent(Call, String, Bundle).

No assumptions should be made as to how an In-Call UI or service will handle these events. The ConnectionService must assume that the In-Call UI could even chose to ignore some events altogether.

Events should be fully qualified (e.g. com.example.event.MY_EVENT) to avoid conflicts between ConnectionService implementations. Further, custom ConnectionService implementations shall not re-purpose events in the android.* namespace, nor shall they define new event types in this namespace. When defining a custom event type, ensure the contents of the extras Bundle is clearly defined. Extra keys for this bundle should be named similar to the event type (e.g. com.example.extra.MY_EXTRA).

When defining events and the associated extras, it is important to keep their behavior consistent when the associated ConnectionService is updated. Support for deprecated events/extras should me maintained to ensure backwards compatibility with older InCallService implementations which were built to support the older behavior.

Expected connection events from the Telephony stack are:

• Connection#EVENT_CALL_HOLD_FAILED with null extras when the Conference could not be held.
• Connection#EVENT_MERGE_START with null extras when a new call is being merged into the conference.
• Connection#EVENT_MERGE_COMPLETE with null extras a new call has completed being merged into the conference.
• Connection#EVENT_CALL_MERGE_FAILED with null extras a new call has failed to merge into the conference (the dialer app can determine which call failed to merge based on the fact that the call still exists outside of the conference at the end of the merge process).

setActive

fun setActive(): Unit

Sets state to be active.

setConferenceableConnections

fun setConferenceableConnections(conferenceableConnections: MutableList<Connection!>!): Unit

Sets the connections with which this connection can be conferenced.

setConnectionCapabilities

fun setConnectionCapabilities(connectionCapabilities: Int): Unit

Sets the capabilities of a conference. See CAPABILITY_* constants of class Connection for valid values.

setConnectionProperties

fun setConnectionProperties(connectionProperties: Int): Unit

Sets the properties of a conference. See PROPERTY_* constants of class Connection for valid values.

setConnectionStartElapsedRealTime

fun setConnectionStartElapsedRealTime(connectionStartElapsedRealTime: Long): Unit

Deprecated: use setConnectionStartElapsedRealtimeMillis(long) instead.

Sets the start time of the Conference which is the basis for the determining the duration of the Conference.

You should use a value returned by SystemClock#elapsedRealtime() to ensure that time zone changes do not impact the conference duration.

When setting this, you should also set the connection time via setConnectionTime(long).

setConnectionStartElapsedRealtimeMillis

fun setConnectionStartElapsedRealtimeMillis(connectionStartElapsedRealTime: Long): Unit

Sets the start time of the Conference which is the basis for the determining the duration of the Conference.

You should use a value returned by SystemClock#elapsedRealtime() to ensure that time zone changes do not impact the conference duration.

When setting this, you should also set the connection time via setConnectionTime(long).

setConnectionTime

fun setConnectionTime(connectionTimeMillis: Long): Unit

Sets the connection start time of the Conference. This is used in the call log to indicate the date and time when the conference took place.

Should be specified in wall-clock time returned by System#currentTimeMillis().

When setting the connection time, you should always set the connection elapsed time via setConnectionStartElapsedRealtimeMillis(long) to ensure the duration is reflected.

setDialing

fun setDialing(): Unit

Sets state to be dialing.

setDisconnected

fun setDisconnected(disconnectCause: DisconnectCause!): Unit

Sets state to disconnected.

setExtras

fun setExtras(extras: Bundle?): Unit

Replaces all the extras associated with this Conference.

New or existing keys are replaced in the Conference extras. Keys which are no longer in the new extras, but were present the last time setExtras was called are removed.

Alternatively you may use the putExtras(android.os.Bundle), and removeExtras(java.lang.String...) methods to modify the extras.

No assumptions should be made as to how an In-Call UI or service will handle these extras. Keys should be fully qualified (e.g., com.example.extras.MY_EXTRA) to avoid conflicts.

setOnHold

fun setOnHold(): Unit

Sets state to be on hold.

setRingbackRequested

fun setRingbackRequested(ringback: Boolean): Unit

Requests that the framework play a ringback tone. This is to be invoked by implementations that do not play a ringback tone themselves in the conference's audio stream.

setRinging

fun setRinging(): Unit

Sets state to be ringing.

setStatusHints

fun setStatusHints(statusHints: StatusHints!): Unit

Sets the label and icon status to display in the InCall UI.

setVideoProvider

fun setVideoProvider(
    c: Connection!, 
    videoProvider: Connection.VideoProvider!
): Unit

Sets the video connection provider.

setVideoState

fun setVideoState(
    c: Connection!, 
    videoState: Int
): Unit

Set the video state for the conference. Valid values: VideoProfile#STATE_AUDIO_ONLY, VideoProfile#STATE_BIDIRECTIONAL, VideoProfile#STATE_TX_ENABLED, VideoProfile#STATE_RX_ENABLED.

toString

open fun toString(): String