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

Commit 434fc2c5 authored by Tyler Gunn's avatar Tyler Gunn
Browse files

Clarify API docs for getCannedTextResponses. 

The API docs do not clearly indicate the fact that canned text responses
may not be available when a call is first added.  Updating the API docs
to clarify this and reference the listener a developer can use to be
informed of changes to the canned responses.

Test: Docs only change.
Bug: 162843384
Change-Id: I52ced96439b2dfa31c1f2428979ab54466763afa
parent fe6160ab

telecomm/java/android/telecom/Call.java

+7 −1
Original line number Diff line number Diff line
@@ -2111,7 +2111,13 @@ public final class Call { 


    /**

     * Obtains a list of canned, pre-configured message responses to present to the user as

     * ways of rejecting this {@code Call} using via a text message.

     * ways of rejecting an incoming {@code Call} using via a text message.

     * <p>

     * <em>Note:</em> Since canned responses may be loaded from the file system, they are not

     * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}

     * via {@link InCallService#onCallAdded(Call)}.  The callback

     * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned

     * responses for the call become available.

     *

     * @see #reject(boolean, String)

     *