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

Commit 91cb21b6 authored by Tyler Gunn's avatar Tyler Gunn
Browse files

Update Javadoc for `TelecomManager.endCall()`. 

Clarify that a ringing call is only rejected if it is the only call. Otherwise, the foreground (active) call is ended. Also, extend the privileged caller requirement for ending calls to include transactional calls.

Flag: EXEMPT docs only change.
Test: None; this change updates docs to match the actual API behavior.
Bug: 424787945
Change-Id: I13976dd8f81b786bf070b5b84b93665799abfe7a
parent 9a368d9b

telecomm/framework/java/android/telecom/TelecomManager.java

+5 −5
Original line number Diff line number Diff line
@@ -2188,15 +2188,15 @@ public class TelecomManager { 
    /**

     * Ends the foreground call on the device.

     * <p>

     * If there is a ringing call, calling this method rejects the ringing call. Otherwise, the

     * foreground call is ended.

     * If there is a single call and it is ringing, calling this method rejects the ringing call.

     * Otherwise, the foreground (active) call is ended preferentially.

     * <p>

     * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}

     * if an attempt is made to end an emergency call.

     * <p>

     * Note: If the foreground call on this device is self-managed, this method will only end

     * the call if the caller of this method is privileged (i.e. system, shell, or root) or system

     * UI.

     * Note: If the foreground call on this device is self-managed or transactional, this method

     * will only end the call if the caller of this method is privileged (i.e. system, shell, or

     * root) or system UI.

     *

     * @return {@code true} if there is a call which will be rejected or terminated, {@code false}

     * otherwise.