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

Commit b36dcb00 authored by Nathan Harold's avatar Nathan Harold
Browse files

Add Applicability Language to Usage Settings 

In order to ensure that the API contract is clear, move some
language from proposed CDD language onto the actual API surface
itself to clarify when various usage settings need to be supported.

Bug: 225950273
Test: make offline-sdk-docs (docstring only changes)
Change-Id: Idee297aaf7ac3af7f5fb86d85d806da13011c036
parent 4bf66d6e

telephony/java/android/telephony/CarrierConfigManager.java

+4 −0
Original line number Original line Diff line number Diff line
@@ -4754,10 +4754,14 @@ public class CarrierConfigManager { 
     * Either omit this key or pass a value of

     * Either omit this key or pass a value of

     * {@link SubscriptionManager#USAGE_SETTING_UNKNOWN unknown} to preserve the current setting.

     * {@link SubscriptionManager#USAGE_SETTING_UNKNOWN unknown} to preserve the current setting.

     *

     *

     * <p>Devices that support configuration of the cellular usage setting, including devices

     * with HAL capability to set the cellular usage setting, must honor this setting accordingly.

     *

     * {@link SubscriptionManager#USAGE_SETTING_DEFAULT default},

     * {@link SubscriptionManager#USAGE_SETTING_DEFAULT default},

     * {@link SubscriptionManager#USAGE_SETTING_VOICE_CENTRIC voice-centric},

     * {@link SubscriptionManager#USAGE_SETTING_VOICE_CENTRIC voice-centric},

     * or {@link SubscriptionManager#USAGE_SETTING_DATA_CENTRIC data-centric}.

     * or {@link SubscriptionManager#USAGE_SETTING_DATA_CENTRIC data-centric}.

     * {@see SubscriptionInfo#getUsageSetting}

     * {@see SubscriptionInfo#getUsageSetting}

     *

     */

     */

    public static final String KEY_CELLULAR_USAGE_SETTING_INT =

    public static final String KEY_CELLULAR_USAGE_SETTING_INT =

            "cellular_usage_setting_int";

            "cellular_usage_setting_int";

telephony/java/android/telephony/SubscriptionManager.java

+8 −0
Original line number Original line Diff line number Diff line
@@ -1085,6 +1085,10 @@ public class SubscriptionManager { 
     * <p>Refer to voice-centric mode in 3gpp 24.301 sec 4.3 and 3gpp 24.501 sec 4.3.

     * <p>Refer to voice-centric mode in 3gpp 24.301 sec 4.3 and 3gpp 24.501 sec 4.3.

     * Also refer to "UE's usage setting" as defined in 3gpp 24.301 section 3.1 and 3gpp 23.221

     * Also refer to "UE's usage setting" as defined in 3gpp 24.301 section 3.1 and 3gpp 23.221

     * Annex A.

     * Annex A.

     *

     * <p>Devices that support {@link PackageManager#FEATURE_TELEPHONY_CALLING} and support usage

     * setting configuration must support setting this value via

     * {@link CarrierConfigManager#KEY_CELLULAR_USAGE_SETTING_INT}.

     */

     */

    public static final int USAGE_SETTING_VOICE_CENTRIC = 1;

    public static final int USAGE_SETTING_VOICE_CENTRIC = 1;
@@ -1094,6 +1098,10 @@ public class SubscriptionManager { 
     * <p>Refer to data-centric mode in 3gpp 24.301 sec 4.3 and 3gpp 24.501 sec 4.3.

     * <p>Refer to data-centric mode in 3gpp 24.301 sec 4.3 and 3gpp 24.501 sec 4.3.

     * Also refer to "UE's usage setting" as defined in 3gpp 24.301 section 3.1 and 3gpp 23.221

     * Also refer to "UE's usage setting" as defined in 3gpp 24.301 section 3.1 and 3gpp 23.221

     * Annex A.

     * Annex A.

     *

     * <p>Devices that support {@link PackageManager#FEATURE_TELEPHONY_DATA} and support usage

     * setting configuration must support setting this value via.

     * {@link CarrierConfigManager#KEY_CELLULAR_USAGE_SETTING_INT}.

     */

     */

    public static final int USAGE_SETTING_DATA_CENTRIC = 2;

    public static final int USAGE_SETTING_DATA_CENTRIC = 2;