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

Commit 1aee57aa authored by Nathan Harold's avatar Nathan Harold
Browse files

Update CellInfo Documentation on Updates 

-Clarify that updates to CellInfo are not guaranteed
 regardless of SDK level.
-Suggest that callers use getTimeStamp() to see how
 old/new the cached CellInfo data is.

Bug: 122617476
Test: make offline-sdk-docs (docstring only change)
Change-Id: Ie9f3597ab2ba027179ce3c37cfeb551e8f659886
parent 821857f7

telephony/java/android/telephony/TelephonyManager.java

+5 −4
Original line number Diff line number Diff line
@@ -4866,12 +4866,13 @@ public class TelephonyManager { 
     *

     * <p>Apps targeting {@link android.os.Build.VERSION_CODES#Q Android Q} or higher will no

     * longer trigger a refresh of the cached CellInfo by invoking this API. Instead, those apps

     * will receive the latest cached results. Apps targeting

     * will receive the latest cached results, which may not be current. Apps targeting

     * {@link android.os.Build.VERSION_CODES#Q Android Q} or higher that wish to request updated

     * CellInfo should call

     * {android.telephony.TelephonyManager#requestCellInfoUpdate requestCellInfoUpdate()} and

     * listen for responses via {@link android.telephony.PhoneStateListener#onCellInfoChanged

     * onCellInfoChanged()}.

     * {@link android.telephony.TelephonyManager#requestCellInfoUpdate requestCellInfoUpdate()};

     * however, in all cases, updates will be rate-limited and are not guaranteed. To determine the

     * recency of CellInfo data, callers should check

     * {@link android.telephony.CellInfo#getTimeStamp CellInfo#getTimeStamp()}.

     *

     * <p>This method returns valid data for devices with

     * {@link android.content.pm.PackageManager#FEATURE_TELEPHONY FEATURE_TELEPHONY}. In cases