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

Commit 3be73d39 authored by Greg Kaiser's avatar Greg Kaiser
Browse files

ContextHubManager: Document InstanceInfo bug 

Our getNanoAppInstanceInfo() method returns incorrect information
for several fields in many cases.  We're too late in the release
cycle to fix the core of this issue, but we can at least document
it so users aren't surprised.

Bug: 30944457
Change-Id: I9330c3b77d08c36befbe20258c6cc45dc640f103
parent 4ecc9d2d

core/java/android/hardware/location/ContextHubManager.java

+18 −0
Original line number Diff line number Diff line
@@ -169,6 +169,24 @@ public final class ContextHubManager { 
    /**

     * get information about the nano app instance

     *

     * NOTE: The returned NanoAppInstanceInfo does _not_ contain correct

     * information for several fields, specifically:

     * - getName()

     * - getPublisher()

     * - getNeededExecMemBytes()

     * - getNeededReadMemBytes()

     * - getNeededWriteMemBytes()

     *

     * For example, say you call loadNanoApp() with a NanoApp that has

     * getName() returning "My Name".  Later, if you call getNanoAppInstanceInfo

     * for that nanoapp, the returned NanoAppInstanceInfo's getName()

     * method will claim "Preloaded app, unknown", even though you would

     * have expected "My Name".  For now, as the user, you'll need to

     * separately track the above fields if they are of interest to you.

     *

     * TODO(b/30943489): Have the returned NanoAppInstanceInfo contain the

     *     correct information.

     *

     * @param nanoAppHandle handle of the nanoAppInstance

     * @return NanoAppInstanceInfo Information about the nano app instance.

     *