Merge "Add an unblock API to BlockedNumberContract." into nyc-dev
diff --git a/api/current.txt b/api/current.txt
index 95eeeee..cd1d6df 100644
--- a/api/current.txt
+++ b/api/current.txt
@@ -30396,6 +30396,7 @@
public class BlockedNumberContract {
method public static boolean canCurrentUserBlockNumbers(android.content.Context);
method public static boolean isBlocked(android.content.Context, java.lang.String);
+ method public static int unblock(android.content.Context, java.lang.String);
field public static final java.lang.String AUTHORITY = "com.android.blockednumber";
field public static final android.net.Uri AUTHORITY_URI;
}
diff --git a/api/system-current.txt b/api/system-current.txt
index 507a1a7..822a054 100644
--- a/api/system-current.txt
+++ b/api/system-current.txt
@@ -32711,6 +32711,7 @@
public class BlockedNumberContract {
method public static boolean canCurrentUserBlockNumbers(android.content.Context);
method public static boolean isBlocked(android.content.Context, java.lang.String);
+ method public static int unblock(android.content.Context, java.lang.String);
field public static final java.lang.String AUTHORITY = "com.android.blockednumber";
field public static final android.net.Uri AUTHORITY_URI;
}
diff --git a/api/test-current.txt b/api/test-current.txt
index c382c3d..ffbd5a5 100644
--- a/api/test-current.txt
+++ b/api/test-current.txt
@@ -30465,6 +30465,7 @@
public class BlockedNumberContract {
method public static boolean canCurrentUserBlockNumbers(android.content.Context);
method public static boolean isBlocked(android.content.Context, java.lang.String);
+ method public static int unblock(android.content.Context, java.lang.String);
field public static final java.lang.String AUTHORITY = "com.android.blockednumber";
field public static final android.net.Uri AUTHORITY_URI;
}
diff --git a/core/java/android/provider/BlockedNumberContract.java b/core/java/android/provider/BlockedNumberContract.java
index 6fe0189..e90dc9c 100644
--- a/core/java/android/provider/BlockedNumberContract.java
+++ b/core/java/android/provider/BlockedNumberContract.java
@@ -15,6 +15,7 @@
*/
package android.provider;
+import android.annotation.WorkerThread;
import android.content.Context;
import android.net.Uri;
import android.os.Bundle;
@@ -109,6 +110,8 @@
* Uri uri = getContentResolver().insert(BlockedNumbers.CONTENT_URI, values);
* getContentResolver().delete(uri, null, null);
* </pre>
+ * To check if a particular number is blocked, use the method
+ * {@link #isBlocked(Context, String)}.
* </p>
* </dd>
* <dt><b>Query</b></dt>
@@ -120,8 +123,12 @@
* new String[]{BlockedNumbers.COLUMN_ID, BlockedNumbers.COLUMN_ORIGINAL_NUMBER,
* BlockedNumbers.COLUMN_E164_NUMBER}, null, null, null);
* </pre>
- * To check if a particular number is blocked, use the method
- * {@link #isBlocked(Context, String)}.
+ * </p>
+ * </dd>
+ * <dt><b>Unblock</b></dt>
+ * <dd>
+ * <p>
+ * Use the method {@link #unblock(Context, String)} to unblock numbers.
* </p>
* </dd>
*
@@ -206,9 +213,15 @@
public static final String METHOD_IS_BLOCKED = "is_blocked";
/** @hide */
+ public static final String METHOD_UNBLOCK= "unblock";
+
+ /** @hide */
public static final String RES_NUMBER_IS_BLOCKED = "blocked";
/** @hide */
+ public static final String RES_NUM_ROWS_DELETED = "num_deleted";
+
+ /** @hide */
public static final String METHOD_CAN_CURRENT_USER_BLOCK_NUMBERS =
"can_current_user_block_numbers";
@@ -217,9 +230,15 @@
/**
* Returns whether a given number is in the blocked list.
+ *
+ * <p> This matches the {@code phoneNumber} against the
+ * {@link BlockedNumbers#COLUMN_ORIGINAL_NUMBER} column, and the E164 representation of the
+ * {@code phoneNumber} with the {@link BlockedNumbers#COLUMN_E164_NUMBER} column.
+ *
* <p> Note that if the {@link #canCurrentUserBlockNumbers} is {@code false} for the user
* context {@code context}, this method will throw an {@link UnsupportedOperationException}.
*/
+ @WorkerThread
public static boolean isBlocked(Context context, String phoneNumber) {
final Bundle res = context.getContentResolver().call(
AUTHORITY_URI, METHOD_IS_BLOCKED, phoneNumber, null);
@@ -227,6 +246,30 @@
}
/**
+ * Unblocks the {@code phoneNumber} if it is blocked.
+ *
+ * <p> Returns the number of rows deleted in the blocked number provider as a result of unblock.
+ *
+ * <p> This deletes all rows where the {@code phoneNumber} matches the
+ * {@link BlockedNumbers#COLUMN_ORIGINAL_NUMBER} column or the E164 representation of the
+ * {@code phoneNumber} matches the {@link BlockedNumbers#COLUMN_E164_NUMBER} column.
+ *
+ * <p>To delete rows based on exact match with specific columns such as
+ * {@link BlockedNumbers#COLUMN_ID} use
+ * {@link android.content.ContentProvider#delete(Uri, String, String[])} with
+ * {@link BlockedNumbers#CONTENT_URI} URI.
+ *
+ * <p> Note that if the {@link #canCurrentUserBlockNumbers} is {@code false} for the user
+ * context {@code context}, this method will throw an {@link UnsupportedOperationException}.
+ */
+ @WorkerThread
+ public static int unblock(Context context, String phoneNumber) {
+ final Bundle res = context.getContentResolver().call(
+ AUTHORITY_URI, METHOD_UNBLOCK, phoneNumber, null);
+ return res.getInt(RES_NUM_ROWS_DELETED, 0);
+ }
+
+ /**
* Returns {@code true} if blocking numbers is supported for the current user.
* <p> Typically, blocking numbers is only supported for one user at a time.
*/