summaryrefslogtreecommitdiff
path: root/core/java/android/bluetooth/BluetoothDevice.java
diff options
context:
space:
mode:
authorRahul Sabnis <rahulsabnis@google.com>2021-03-23 19:07:24 +0000
committerAndroid (Google) Code Review <android-gerrit@google.com>2021-03-23 19:07:24 +0000
commit7030bd354feabc16bcd658d973790c515e5bce6f (patch)
treeb990c10744ac3fca6348d31460e3104a0b797d61 /core/java/android/bluetooth/BluetoothDevice.java
parent77cbe77bebf42c6eca44b420195fa8b426d3f1b7 (diff)
parentc7635a46e7554fae3fe5f0f0d02dffe69c6f7e10 (diff)
Merge "Makes BluetoothDevice#setAlias a public API" into sc-dev
Diffstat (limited to 'core/java/android/bluetooth/BluetoothDevice.java')
-rw-r--r--core/java/android/bluetooth/BluetoothDevice.java32
1 files changed, 21 insertions, 11 deletions
diff --git a/core/java/android/bluetooth/BluetoothDevice.java b/core/java/android/bluetooth/BluetoothDevice.java
index 89086497a446..a96c14f216f3 100644
--- a/core/java/android/bluetooth/BluetoothDevice.java
+++ b/core/java/android/bluetooth/BluetoothDevice.java
@@ -26,6 +26,7 @@ import android.annotation.SdkConstant.SdkConstantType;
import android.annotation.SuppressLint;
import android.annotation.SystemApi;
import android.app.PropertyInvalidatedCache;
+import android.companion.AssociationRequest;
import android.compat.annotation.UnsupportedAppUsage;
import android.content.Context;
import android.os.Build;
@@ -1231,8 +1232,7 @@ public final class BluetoothDevice implements Parcelable {
}
/**
- * Get the Bluetooth alias of the remote device.
- * <p>Alias is the locally modified name of a remote device.
+ * Get the locally modifiable name (alias) of the remote Bluetooth device.
*
* @return the Bluetooth alias, the friendly device name if no alias, or
* null if there was a problem
@@ -1258,25 +1258,35 @@ public final class BluetoothDevice implements Parcelable {
}
/**
- * Set the Bluetooth alias of the remote device.
- * <p>Alias is the locally modified name of a remote device.
- * <p>This methoid overwrites the alias. The changed
- * alias is saved in the local storage so that the change
- * is preserved over power cycle.
+ * Sets the locally modifiable name (alias) of the remote Bluetooth device. This method
+ * overwrites the previously stored alias. The new alias is saved in local
+ * storage so that the change is preserved over power cycles.
*
- * @return true on success, false on error
- * @hide
+ * <p>This method requires the calling app to be associated with Companion Device Manager (see
+ * {@link android.companion.CompanionDeviceManager#associate(AssociationRequest,
+ * android.companion.CompanionDeviceManager.Callback, Handler)}) and have the {@link
+ * android.Manifest.permission#BLUETOOTH} permission. Alternatively, if the caller has the
+ * {@link android.Manifest.permission#BLUETOOTH_PRIVILEGED} permission, they can bypass the
+ * Companion Device Manager association requirement.
+ *
+ * @param alias is the new locally modifiable name for the remote Bluetooth device which must be
+ * non-null and not the empty string.
+ * @return {@code true} if the alias is successfully set, {@code false} on error
+ * @throws IllegalArgumentException if the alias is {@code null} or the empty string
*/
- @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
@RequiresPermission(Manifest.permission.BLUETOOTH)
public boolean setAlias(@NonNull String alias) {
+ if (alias == null || alias.isEmpty()) {
+ throw new IllegalArgumentException("Cannot set the alias to null or the empty string");
+ }
final IBluetooth service = sService;
if (service == null) {
Log.e(TAG, "BT not enabled. Cannot set Remote Device name");
return false;
}
try {
- return service.setRemoteAlias(this, alias);
+ BluetoothAdapter adapter = BluetoothAdapter.getDefaultAdapter();
+ return service.setRemoteAlias(this, alias, adapter.getOpPackageName());
} catch (RemoteException e) {
Log.e(TAG, "", e);
}