Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update javadoc of TM#getDataNetworkType to align with implementation

Browse Source 
Javadoc of TelephonyManager#getDataNetworkType says if the
TelephonyManager object is not created with createForSubscriptionId,
then applies to SubscriptionManager#getDefaultDataSubscriptionId().

But the actual implementation applies to
SubscriptionManager#getActiveDataSubscriptionId() instead. While they
are not always the same (e.g. when opptunistic network is active), the
implementation is more accurate than the javadoc.

Bug: 144803512
Test: make docs
Change-Id: I7db32a9a99dd5d7f7c32b6b33f3d5f7bd09a0e02
This commit is contained in:
Rambo Wang
2021-05-24 12:57:49 -07:00
parent 94a4cdd4e8
commit 0bacf4f46b
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
telephony/java/android/telephony/TelephonyManager.java
View File

@@ -2932,7 +2932,12 @@ public class TelephonyManager {
* currently in use on the device for data transmission.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the given
* subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
* subId. Otherwise, applies to {@link SubscriptionManager#getActiveDataSubscriptionId()}.
*
* Note: Before {@link SubscriptionManager#getActiveDataSubscriptionId()} was introduced in API
* level 30, it was applied to {@link SubscriptionManager#getDefaultDataSubscriptionId()} which
* may be different now from {@link SubscriptionManager#getActiveDataSubscriptionId()}, e.g.
* when opportunistic network is providing cellular internet connection to the user.
*
* <p>Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).