Updated RxBleClient#getBondedDevices() javadoc. (#804)

Mentioning new requirements for Android 12 / API >= 31.
dariuszseweryn · Jul 9, 2022 · fb8991b · fb8991b
1 parent ef2db2d
commit fb8991b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/rxandroidble/src/main/java/com/polidea/rxandroidble2/RxBleClient.java b/rxandroidble/src/main/java/com/polidea/rxandroidble2/RxBleClient.java
@@ -101,8 +101,11 @@ public static void updateLogOptions(LogOptions logOptions) {
      * If Bluetooth state is not STATE_ON, this API will return an empty set. After turning on Bluetooth, wait for ACTION_STATE_CHANGED
      * with STATE_ON to get the updated value.
      *
+     * Calling this function on or above Android 12 (API >= 31) requires BLUETOOTH_CONNECT runtime permission.
+     *
      * @return set of currently bonded devices
      * @throws UnsupportedOperationException if called on system without Bluetooth capabilities
+     * @throws java.lang.SecurityException if called on Android 12 or newer (API >= 31) and no BLUETOOTH_CONNECT runtime permission granted
      */
     public abstract Set<RxBleDevice> getBondedDevices();