From 6ac54dc51916bccc61417f2e9cabacc1531f7226 Mon Sep 17 00:00:00 2001 From: tonyzhu Date: Mon, 19 Nov 2018 15:00:00 +0800 Subject: [API Review]Clarify method that obtain a component name Change JavaDoc in CarrierConfigManager.java. Clarify what format string will be set and get from the key. Using ComponentName methods to convert. Bug: 118675660 Test: build success. Change-Id: I47db5b665808ef7dbc9081e0112a04958497d6fd --- .../java/android/telephony/CarrierConfigManager.java | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/telephony/java/android/telephony/CarrierConfigManager.java b/telephony/java/android/telephony/CarrierConfigManager.java index 90c15ffa44c1..8b9e01d03fac 100644 --- a/telephony/java/android/telephony/CarrierConfigManager.java +++ b/telephony/java/android/telephony/CarrierConfigManager.java @@ -25,6 +25,7 @@ import android.annotation.SystemApi; import android.annotation.SystemService; import android.annotation.TestApi; import android.annotation.UnsupportedAppUsage; +import android.content.ComponentName; import android.content.Context; import android.os.PersistableBundle; import android.os.RemoteException; @@ -1153,11 +1154,20 @@ public class CarrierConfigManager { */ public static final String KEY_CARRIER_NAME_STRING = "carrier_name_string"; - /** - * The Component Name of a carrier-provided CallScreeningService implementation. Telecom will - * bind to this CallScreeningService for ALL incoming calls and provide the carrier - * CallScreeningService with the opportunity to allow or block calls. - */ + /** + * The Component Name of a carrier-provided CallScreeningService implementation. Telecom will + * bind to {@link android.telecom.CallScreeningService} for ALL incoming calls and provide + * the carrier + * CallScreeningService with the opportunity to allow or block calls. + *

+ * The String includes the package name/the class name. + * Example: + * com.android.carrier/com.android.carrier.callscreeningserviceimpl + *

+ * Using {@link ComponentName#flattenToString()} to convert a ComponentName object to String. + * Using {@link ComponentName#unflattenFromString(String)} to convert a String object to a + * ComponentName. + */ public static final String KEY_CARRIER_CALL_SCREENING_APP_STRING = "call_screening_app"; /** -- cgit v1.2.3-59-g8ed1b