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

Commit 629271aa authored by Yohei Yukawa's avatar Yohei Yukawa
Browse files

Improve API documents of some IME query APIs 

This is a follow up CL to my previous CL [1], which enabled following
IME query APIs to return the result based on the caller's user ID, not
based on the current IME user, even when they get called from
background users.

 * InputMethodManager#getInputMethodList()
 * InputMethodManager#getEnabledInputMethodList()
 * InputMethodManager#getEnabledInputMethodSubtypeList()

This CL just clarifies it in the API documents.

This is purely a document fix.  There should be no behavior change.

 [1]: I192a0f5a1375170d17a4c08af94f23966dbaea8b
      7f8ee4b9

Bug: 13002424
Bug: 122164939
Test: make -j checkbuild
Change-Id: I55f51e211a8a47c01469e2d93b04c5c864f0b9ea
parent 391675d7

core/java/android/view/inputmethod/InputMethodManager.java

+17 −0
Original line number Diff line number Diff line
@@ -954,6 +954,13 @@ public final class InputMethodManager { 
        return mIInputContext;

    }



    /**

     * Returns the list of installed input methods.

     *

     * <p>On multi user environment, this API returns a result for the calling process user.</p>

     *

     * @return {@link List} of {@link InputMethodInfo}.

     */

    public List<InputMethodInfo> getInputMethodList() {

        try {

            return mService.getInputMethodList();
@@ -962,6 +969,13 @@ public final class InputMethodManager { 
        }

    }



    /**

     * Returns the list of enabled input methods.

     *

     * <p>On multi user environment, this API returns a result for the calling process user.</p>

     *

     * @return {@link List} of {@link InputMethodInfo}.

     */

    public List<InputMethodInfo> getEnabledInputMethodList() {

        try {

            return mService.getEnabledInputMethodList();
@@ -972,6 +986,9 @@ public final class InputMethodManager { 


    /**

     * Returns a list of enabled input method subtypes for the specified input method info.

     *

     * <p>On multi user environment, this API returns a result for the calling process user.</p>

     *

     * @param imi An input method info whose subtypes list will be returned.

     * @param allowsImplicitlySelectedSubtypes A boolean flag to allow to return the implicitly

     * selected subtypes. If an input method info doesn't have enabled subtypes, the framework