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

Commit c78ccdc3 authored by Rahul Sabnis's avatar Rahul Sabnis
Browse files

Update javadoc to reflect that BluetoothPbap#setConnectionPolicy returns 

true on successfully setting the connection policy instead of on
disconnection. It also now indicates that if
BluetoothProfile#CONNECTION_POLICY_FORBIDDEN is passed in, the profile
will be disconnected.

Bug: 148966894
Test: Manual
Change-Id: I881c240fcbce0c8148625c35e6e88ab02ea7122f
parent c3389265

framework/java/android/bluetooth/BluetoothPbap.java

+9 −6
Original line number Diff line number Diff line
@@ -278,16 +278,19 @@ public class BluetoothPbap implements BluetoothProfile { 
    }



    /**

     * Pbap does not store connection policy, so this function only disconnects pbap if

     * connectionPolicy is {@link #CONNECTION_POLICY_FORBIDDEN}.

     * Set connection policy of the profile and tries to disconnect it if connectionPolicy is

     * {@link BluetoothProfile#CONNECTION_POLICY_FORBIDDEN}

     *

     * <p> The device should already be paired.

     * Connection policy can be one of {@link #CONNECTION_POLICY_ALLOWED},

     * {@link #CONNECTION_POLICY_FORBIDDEN}, {@link #CONNECTION_POLICY_UNKNOWN}

     * Connection policy can be one of:

     * {@link BluetoothProfile#CONNECTION_POLICY_ALLOWED},

     * {@link BluetoothProfile#CONNECTION_POLICY_FORBIDDEN},

     * {@link BluetoothProfile#CONNECTION_POLICY_UNKNOWN}

     *

     * @param device Paired bluetooth device

     * @param connectionPolicy determines whether to disconnect the device

     * @return true if pbap is successfully disconnected, false otherwise

     * @param connectionPolicy is the connection policy to set to for this profile

     * @return true if connectionPolicy is set, false on error

     *

     * @hide

     */

    @SystemApi