Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7c3ddcf0 authored by Tyler Gunn's avatar Tyler Gunn
Browse files

Updates to Telecom API docs for clarity. 

- Update Connection onAnswer/onReject docs to make it more clear for
a self-managed connectionservice that these methods could be called by
the framework or by a car mode in call service.
- Update the Connection onShowIncomingCallUI method to take into account
the new concurrent calling capabilities in P.

Test: Docs only change
Bug: 73112552
Change-Id: Icb47aa15d03d4bfc05380948e30686317124301e
parent af5b90ff

telecomm/java/android/telecom/Connection.java

+46 −4
Original line number Diff line number Diff line
@@ -2731,7 +2731,20 @@ public abstract class Connection extends Conferenceable { 
    /**

     * Notifies this Connection, which is in {@link #STATE_RINGING}, of

     * a request to accept.

     *

     * <p>

     * For managed {@link ConnectionService}s, this will be called when the user answers a call via

     * the default dialer's {@link InCallService}.

     * <p>

     * Although a self-managed {@link ConnectionService} provides its own incoming call UI, the

     * Telecom framework may request that the call is answered in the following circumstances:

     * <ul>

     *     <li>The user chooses to answer an incoming call via a Bluetooth device.</li>

     *     <li>A car mode {@link InCallService} is in use which has declared

     *     {@link TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS} in its manifest.  Such an

     *     {@link InCallService} will be able to see calls from self-managed

     *     {@link ConnectionService}s, and will be able to display an incoming call UI on their

     *     behalf.</li>

     * </ul>

     * @param videoState The video state in which to answer the connection.

     */

    public void onAnswer(int videoState) {}
@@ -2739,6 +2752,20 @@ public abstract class Connection extends Conferenceable { 
    /**

     * Notifies this Connection, which is in {@link #STATE_RINGING}, of

     * a request to accept.

     * <p>

     * For managed {@link ConnectionService}s, this will be called when the user answers a call via

     * the default dialer's {@link InCallService}.

     * <p>

     * Although a self-managed {@link ConnectionService} provides its own incoming call UI, the

     * Telecom framework may request that the call is answered in the following circumstances:

     * <ul>

     *     <li>The user chooses to answer an incoming call via a Bluetooth device.</li>

     *     <li>A car mode {@link InCallService} is in use which has declared

     *     {@link TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS} in its manifest.  Such an

     *     {@link InCallService} will be able to see calls from self-managed

     *     {@link ConnectionService}s, and will be able to display an incoming call UI on their

     *     behalf.</li>

     * </ul>

     */

    public void onAnswer() {

        onAnswer(VideoProfile.STATE_AUDIO_ONLY);
@@ -2747,6 +2774,20 @@ public abstract class Connection extends Conferenceable { 
    /**

     * Notifies this Connection, which is in {@link #STATE_RINGING}, of

     * a request to reject.

     * <p>

     * For managed {@link ConnectionService}s, this will be called when the user rejects a call via

     * the default dialer's {@link InCallService}.

     * <p>

     * Although a self-managed {@link ConnectionService} provides its own incoming call UI, the

     * Telecom framework may request that the call is rejected in the following circumstances:

     * <ul>

     *     <li>The user chooses to reject an incoming call via a Bluetooth device.</li>

     *     <li>A car mode {@link InCallService} is in use which has declared

     *     {@link TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS} in its manifest.  Such an

     *     {@link InCallService} will be able to see calls from self-managed

     *     {@link ConnectionService}s, and will be able to display an incoming call UI on their

     *     behalf.</li>

     * </ul>

     */

    public void onReject() {}
@@ -2829,9 +2870,10 @@ public abstract class Connection extends Conferenceable { 
     * should show its own incoming call user interface.

     * <p>

     * Where there are ongoing calls in other self-managed {@link ConnectionService}s, or in a

     * regular {@link ConnectionService}, the Telecom framework will display its own incoming call

     * user interface to allow the user to choose whether to answer the new incoming call and

     * disconnect other ongoing calls, or to reject the new incoming call.

     * regular {@link ConnectionService}, and it is not possible to hold these other calls, the

     * Telecom framework will display its own incoming call user interface to allow the user to

     * choose whether to answer the new incoming call and disconnect other ongoing calls, or to

     * reject the new incoming call.

     * <p>

     * You should trigger the display of the incoming call user interface for your application by

     * showing a {@link Notification} with a full-screen {@link Intent} specified.