java.lang.Object
- org.robolectric.shadows.ShadowBluetoothAdapter

@Implements(value=android.bluetooth.BluetoothAdapter.class,
            looseSignatures=true)
public class ShadowBluetoothAdapter
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`RFCOMM_LISTENER_FAILED_TO_CLOSE_SERVER_SOCKET`	Equivalent value to internal SystemApi `BluetoothStatusCodes.RFCOMM_LISTENER_FAILED_TO_CLOSE_SERVER_SOCKET`.
`static int`	`RFCOMM_LISTENER_OPERATION_FAILED_NO_MATCHING_SERVICE_RECORD`	Equivalent value to internal SystemApi `BluetoothStatusCodes.RFCOMM_LISTENER_OPERATION_FAILED_NO_MATCHING_SERVICE_RECORD`.
`static int`	`RFCOMM_LISTENER_START_FAILED_UUID_IN_USE`	Equivalent value to internal SystemApi `BluetoothStatusCodes.RFCOMM_LISTENER_START_FAILED_UUID_IN_USE`.

Constructor Summary

Constructors
Constructor Description

ShadowBluetoothAdapter()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`BluetoothSocket`	`addIncomingRfcommConnection(BluetoothDevice remoteDevice, UUID uuid)`	Creates an incoming socket connection from the given `BluetoothDevice` to a background Bluetooth server created with `BluetoothAdapter.startRfcommServer(String, UUID, PendingIntent)` on the given uuid.
`protected boolean`	`cancelDiscovery()`
`protected static boolean`	`checkBluetoothAddress(String address)`	Validate a Bluetooth address, such as "00:43:A8:23:10:F0" Alphabetic characters must be uppercase to be valid.
`protected void`	`closeProfileProxy(int profile, BluetoothProfile proxy)`	Overrides behavior of `closeProfileProxy(int,android.bluetooth.BluetoothProfile)` if `setProfileProxy(int, android.bluetooth.BluetoothProfile)` has been previously called.
`protected static Object`	`createAdapter(Object attributionSource)`	Requires LooseSignatures because of `AttributionSource` parameter
`protected boolean`	`disable()`
`protected boolean`	`enable()`
`protected String`	`getAddress()`
`protected Set<BluetoothDevice>`	`getBondedDevices()`
`protected static BluetoothAdapter`	`getDefaultAdapter()`
`protected Object`	`getDiscoverableTimeout()`	Needs looseSignatures because the return value changed from `int` to `Duration` starting in T.
`protected int`	`getLeMaximumAdvertisingDataLength()`
`Set<BluetoothAdapter.LeScanCallback>`	`getLeScanCallbacks()`
`int`	`getLeState()`	Decides the correct LE state.
`protected String`	`getName()`
`protected int`	`getProfileConnectionState(int profile)`	Returns the connection state for the given Bluetooth `profile`, defaulting to `BluetoothProfile.STATE_DISCONNECTED` if the profile's connection state was never set.
`protected boolean`	`getProfileProxy(Context context, BluetoothProfile.ServiceListener listener, int profile)`	Overrides behavior of `getProfileProxy(android.content.Context,android.bluetooth.BluetoothProfile.ServiceListener,int)` if `setProfileProxy(int, android.bluetooth.BluetoothProfile)` has been previously called.
`Set<UUID>`	`getRegisteredRfcommServerUuids()`	Returns an immutable set of `UUID`s representing the currently registered RFCOMM servers.
`protected BluetoothDevice`	`getRemoteDevice(String address)`
`protected int`	`getScanMode()`
`BluetoothAdapter.LeScanCallback`	`getSingleLeScanCallback()`
`protected int`	`getState()`
`boolean`	`hasActiveProfileProxy(int profile)`
`protected boolean`	`isBleScanAlwaysAvailable()`	When true, overrides the value of `getLeState()`.
`protected boolean`	`isDiscovering()`
`protected boolean`	`isEnabled()`
`protected boolean`	`isLeExtendedAdvertisingSupported()`	Returns the last value of `setIsLeExtendedAdvertisingSupported(boolean)`, defaulting to true.
`protected boolean`	`isMultipleAdvertisementSupported()`
`protected BluetoothServerSocket`	`listenUsingInsecureL2capChannel()`
`protected BluetoothServerSocket`	`listenUsingInsecureRfcommWithServiceRecord(String serviceName, UUID uuid)`
`protected BluetoothServerSocket`	`listenUsingL2capChannel()`
`protected BluetoothServerSocket`	`listenUsingRfcommWithServiceRecord(String serviceName, UUID uuid)`
`static void`	`reset()`
`protected BluetoothSocket`	`retrieveConnectedRfcommSocket(UUID uuid)`
`void`	`setAddress(String address)`
`void`	`setBleScanAlwaysAvailable(boolean alwaysAvailable)`	Sets the value for `isBleScanAlwaysAvailable`.
`void`	`setBluetoothLeAdvertiser(BluetoothLeAdvertiser advertiser)`	Deprecated. use real BluetoothLeAdvertiser instead
`void`	`setBondedDevices(Set<BluetoothDevice> bluetoothDevices)`
`protected void`	`setDiscoverableTimeout(int timeout)`
`protected int`	`setDiscoverableTimeout(Duration timeout)`
`void`	`setEnabled(boolean enabled)`	Deprecated. Use `BluetoothAdapter.enable()` or `BluetoothAdapter.disable()`.
`static void`	`setIsBluetoothSupported(boolean supported)`	Determines if getDefaultAdapter() returns the default local adapter (true) or null (false).
`void`	`setIsLeExtendedAdvertisingSupported(boolean supported)`	Sets the isLeExtendedAdvertisingSupported to enable/disable LE extended advertisements feature
`void`	`setIsMultipleAdvertisementSupported(boolean supported)`	Sets the value for `isMultipleAdvertisementSupported`.
`protected boolean`	`setName(String name)`
`void`	`setProfileConnectionState(int profile, int state)`	Sets the connection state `state` for the given BluetoothProfile `profile`
`void`	`setProfileProxy(int profile, BluetoothProfile proxy)`	Sets the active BluetoothProfile `proxy` for the given `profile`.
`protected Object`	`setScanMode(int scanMode)`	Needs looseSignatures because in Android T the return value of this method was changed from bool to int.
`protected boolean`	`setScanMode(int scanMode, int discoverableTimeout)`
`protected boolean`	`setScanMode(int scanMode, long durationMillis)`
`void`	`setState(int state)`
`protected boolean`	`startDiscovery()`
`protected boolean`	`startLeScan(BluetoothAdapter.LeScanCallback callback)`
`protected boolean`	`startLeScan(UUID[] serviceUuids, BluetoothAdapter.LeScanCallback callback)`
`protected int`	`startRfcommServer(String name, UUID uuid, PendingIntent pendingIntent)`
`protected void`	`stopLeScan(BluetoothAdapter.LeScanCallback callback)`
`protected int`	`stopRfcommServer(UUID uuid)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RFCOMM_LISTENER_START_FAILED_UUID_IN_USE
```
public static final int RFCOMM_LISTENER_START_FAILED_UUID_IN_USE
```
    Equivalent value to internal SystemApi BluetoothStatusCodes.RFCOMM_LISTENER_START_FAILED_UUID_IN_USE.
    
    See Also:
    
    Constant Field Values
  - RFCOMM_LISTENER_OPERATION_FAILED_NO_MATCHING_SERVICE_RECORD
```
public static final int RFCOMM_LISTENER_OPERATION_FAILED_NO_MATCHING_SERVICE_RECORD
```
    Equivalent value to internal SystemApi BluetoothStatusCodes.RFCOMM_LISTENER_OPERATION_FAILED_NO_MATCHING_SERVICE_RECORD.
    
    See Also:
    
    Constant Field Values
  - RFCOMM_LISTENER_FAILED_TO_CLOSE_SERVER_SOCKET
```
public static final int RFCOMM_LISTENER_FAILED_TO_CLOSE_SERVER_SOCKET
```
    Equivalent value to internal SystemApi BluetoothStatusCodes.RFCOMM_LISTENER_FAILED_TO_CLOSE_SERVER_SOCKET.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ShadowBluetoothAdapter
```
public ShadowBluetoothAdapter()
```
- Method Detail
  - reset
```
@Resetter
public static void reset()
```
  - getDefaultAdapter
```
@Implementation
protected static BluetoothAdapter getDefaultAdapter()
```
  - createAdapter
```
@Implementation(minSdk=33)
protected static Object createAdapter(Object attributionSource)
```
    Requires LooseSignatures because of AttributionSource parameter
  - setIsBluetoothSupported
```
public static void setIsBluetoothSupported(boolean supported)
```
    Determines if getDefaultAdapter() returns the default local adapter (true) or null (false).
  - setBluetoothLeAdvertiser
```
@Deprecated
public void setBluetoothLeAdvertiser(BluetoothLeAdvertiser advertiser)
```
    Deprecated.
    use real BluetoothLeAdvertiser instead
  - getRemoteDevice
```
@Implementation
protected BluetoothDevice getRemoteDevice(String address)
```
  - getBondedDevices
```
@Implementation
protected Set<BluetoothDevice> getBondedDevices()
```
  - setBondedDevices
```
public void setBondedDevices(Set<BluetoothDevice> bluetoothDevices)
```
  - listenUsingInsecureRfcommWithServiceRecord
```
@Implementation
protected BluetoothServerSocket listenUsingInsecureRfcommWithServiceRecord(String serviceName,
                                                                           UUID uuid)
```
  - listenUsingRfcommWithServiceRecord
```
@Implementation
protected BluetoothServerSocket listenUsingRfcommWithServiceRecord(String serviceName,
                                                                   UUID uuid)
                                                            throws IOException
```
    Throws:
    
    IOException
  - listenUsingInsecureL2capChannel
```
@Implementation(minSdk=29)
protected BluetoothServerSocket listenUsingInsecureL2capChannel()
                                                         throws IOException
```
    Throws:
    
    IOException
  - listenUsingL2capChannel
```
@Implementation(minSdk=29)
protected BluetoothServerSocket listenUsingL2capChannel()
                                                 throws IOException
```
    Throws:
    
    IOException
  - startDiscovery
```
@Implementation
protected boolean startDiscovery()
```
  - cancelDiscovery
```
@Implementation
protected boolean cancelDiscovery()
```
  - isBleScanAlwaysAvailable
```
@Implementation(minSdk=23)
protected boolean isBleScanAlwaysAvailable()
```
    When true, overrides the value of getLeState(). By default, this is false.
  - getLeState
```
@Implementation(minSdk=23)
public int getLeState()
```
    Decides the correct LE state. When off, BLE calls will fail or return null.
    LE is enabled if either Bluetooth or BLE scans are enabled. LE is always off if Airplane Mode is enabled.
  - startLeScan
```
@Implementation(minSdk=18)
protected boolean startLeScan(BluetoothAdapter.LeScanCallback callback)
```
  - startLeScan
```
@Implementation(minSdk=18)
protected boolean startLeScan(UUID[] serviceUuids,
                              BluetoothAdapter.LeScanCallback callback)
```
  - stopLeScan
```
@Implementation(minSdk=18)
protected void stopLeScan(BluetoothAdapter.LeScanCallback callback)
```
  - getLeScanCallbacks
```
public Set<BluetoothAdapter.LeScanCallback> getLeScanCallbacks()
```
  - getSingleLeScanCallback
```
public BluetoothAdapter.LeScanCallback getSingleLeScanCallback()
```
  - isDiscovering
```
@Implementation
protected boolean isDiscovering()
```
  - isEnabled
```
@Implementation
protected boolean isEnabled()
```
  - enable
```
@Implementation
protected boolean enable()
```
  - disable
```
@Implementation
protected boolean disable()
```
  - getAddress
```
@Implementation
protected String getAddress()
```
  - getState
```
@Implementation
protected int getState()
```
  - getName
```
@Implementation
protected String getName()
```
  - setName
```
@Implementation
protected boolean setName(String name)
```
  - setScanMode
```
@Implementation
protected Object setScanMode(int scanMode)
```
    Needs looseSignatures because in Android T the return value of this method was changed from bool to int.
  - setScanMode
```
@Implementation(maxSdk=29)
protected boolean setScanMode(int scanMode,
                              int discoverableTimeout)
```
  - setScanMode
```
@Implementation(minSdk=30,
                maxSdk=32)
protected boolean setScanMode(int scanMode,
                              long durationMillis)
```
  - getScanMode
```
@Implementation
protected int getScanMode()
```
  - getDiscoverableTimeout
```
@Implementation
protected Object getDiscoverableTimeout()
```
    Needs looseSignatures because the return value changed from int to Duration starting in T.
  - setDiscoverableTimeout
```
@Implementation(maxSdk=32)
protected void setDiscoverableTimeout(int timeout)
```
  - setDiscoverableTimeout
```
@Implementation(minSdk=33)
protected int setDiscoverableTimeout(Duration timeout)
```
  - isMultipleAdvertisementSupported
```
@Implementation(minSdk=21)
protected boolean isMultipleAdvertisementSupported()
```
  - checkBluetoothAddress
```
@Implementation
protected static boolean checkBluetoothAddress(String address)
```
    Validate a Bluetooth address, such as "00:43:A8:23:10:F0" Alphabetic characters must be uppercase to be valid.
    
    Parameters:
    
    address - Bluetooth address as string
    
    Returns:
    
    true if the address is valid, false otherwise
  - getProfileConnectionState
```
@Implementation
protected int getProfileConnectionState(int profile)
```
    Returns the connection state for the given Bluetooth profile, defaulting to BluetoothProfile.STATE_DISCONNECTED if the profile's connection state was never set.
    Set a Bluetooth profile's connection state via setProfileConnectionState(int, int).
  - setAddress
```
public void setAddress(String address)
```
  - setState
```
public void setState(int state)
```
  - setEnabled
```
@Deprecated
public void setEnabled(boolean enabled)
```
    Deprecated.
    Use BluetoothAdapter.enable() or BluetoothAdapter.disable().
  - setBleScanAlwaysAvailable
```
public void setBleScanAlwaysAvailable(boolean alwaysAvailable)
```
    Sets the value for isBleScanAlwaysAvailable. If true, getLeState() will always return true.
  - setIsMultipleAdvertisementSupported
```
public void setIsMultipleAdvertisementSupported(boolean supported)
```
    Sets the value for isMultipleAdvertisementSupported.
  - setProfileConnectionState
```
public void setProfileConnectionState(int profile,
                                      int state)
```
    Sets the connection state state for the given BluetoothProfile profile
  - setProfileProxy
```
public void setProfileProxy(int profile,
                            @Nullable
                            BluetoothProfile proxy)
```
    Sets the active BluetoothProfile proxy for the given profile. Will always affect behavior of BluetoothAdapter.getProfileProxy(android.content.Context, android.bluetooth.BluetoothProfile.ServiceListener, int) and BluetoothAdapter.closeProfileProxy(int, android.bluetooth.BluetoothProfile). Call to BluetoothAdapter.closeProfileProxy(int, android.bluetooth.BluetoothProfile) can remove the set active proxy.
    
    Parameters:
    
    proxy - can be 'null' to simulate the situation where BluetoothAdapter.getProfileProxy(android.content.Context, android.bluetooth.BluetoothProfile.ServiceListener, int) would return 'false'. This can happen on older Android versions for Bluetooth profiles introduced in later Android versions.
  - hasActiveProfileProxy
```
public boolean hasActiveProfileProxy(int profile)
```
    Returns:
    
    'true' if active (non-null) proxy has been set by setProfileProxy(int, android.bluetooth.BluetoothProfile) for the given profile AND it has not been "deactivated" by a call to BluetoothAdapter.closeProfileProxy(int, android.bluetooth.BluetoothProfile). Only meaningful if setProfileProxy(int, android.bluetooth.BluetoothProfile) has been previously called.
  - getProfileProxy
```
@Implementation
protected boolean getProfileProxy(Context context,
                                  BluetoothProfile.ServiceListener listener,
                                  int profile)
```
    Overrides behavior of getProfileProxy(android.content.Context,android.bluetooth.BluetoothProfile.ServiceListener,int) if setProfileProxy(int, android.bluetooth.BluetoothProfile) has been previously called.
    If active (non-null) proxy has been set by setProfileProxy(int,android.bluetooth.BluetoothProfile) for the given profile, getProfileProxy(android.content.Context,android.bluetooth.BluetoothProfile.ServiceListener,int) will immediately call onServiceConnected of the given BluetoothProfile.ServiceListener listener.
    
    Returns:
    
    'true' if a proxy object has been set by setProfileProxy(int,android.bluetooth.BluetoothProfile) for the given BluetoothProfile profile
  - closeProfileProxy
```
@Implementation
protected void closeProfileProxy(int profile,
                                 BluetoothProfile proxy)
```
    Overrides behavior of closeProfileProxy(int,android.bluetooth.BluetoothProfile) if setProfileProxy(int, android.bluetooth.BluetoothProfile) has been previously called. If the given non-null BluetoothProfile proxy was previously set for the given profile by setProfileProxy(int, android.bluetooth.BluetoothProfile), this proxy will be "deactivated".
  - isLeExtendedAdvertisingSupported
```
@Implementation(minSdk=26)
protected boolean isLeExtendedAdvertisingSupported()
```
    Returns the last value of setIsLeExtendedAdvertisingSupported(boolean), defaulting to true.
  - setIsLeExtendedAdvertisingSupported
```
public void setIsLeExtendedAdvertisingSupported(boolean supported)
```
    Sets the isLeExtendedAdvertisingSupported to enable/disable LE extended advertisements feature
  - getLeMaximumAdvertisingDataLength
```
@Implementation(minSdk=26)
protected int getLeMaximumAdvertisingDataLength()
```
  - startRfcommServer
```
@Implementation(minSdk=33)
protected int startRfcommServer(String name,
                                UUID uuid,
                                PendingIntent pendingIntent)
```
  - stopRfcommServer
```
@Implementation(minSdk=33)
protected int stopRfcommServer(UUID uuid)
```
  - retrieveConnectedRfcommSocket
```
@Implementation(minSdk=33)
@Nullable
protected BluetoothSocket retrieveConnectedRfcommSocket(UUID uuid)
```
  - addIncomingRfcommConnection
```
public BluetoothSocket addIncomingRfcommConnection(BluetoothDevice remoteDevice,
                                                   UUID uuid)
                                            throws PendingIntent.CanceledException
```
    Creates an incoming socket connection from the given BluetoothDevice to a background Bluetooth server created with BluetoothAdapter.startRfcommServer(String, UUID, PendingIntent) on the given uuid.
    Creating this socket connection will invoke the PendingIntent provided in BluetoothAdapter.startRfcommServer(String, UUID, PendingIntent) when the server socket was created for the given UUID. The component provided in the intent can then call BluetoothAdapter.retrieveConnectedRfcommSocket(UUID) to obtain the server side socket.
    A ShadowBluetoothSocket obtained from the returned BluetoothSocket can be used to send data to and receive data from the server side socket. This returned BluetoothSocket is the same socket as returned by BluetoothAdapter.retrieveConnectedRfcommSocket(UUID) and should generally not be used directly outside of obtaining the shadow, as this socket is normally not exposed outside of the component started by the pending intent. ShadowBluetoothSocket.getInputStreamFeeder() and ShadowBluetoothSocket.getOutputStreamSink() can be used to send data to and from the socket as if it was a remote connection.
    Warning: The socket returned by this method and the corresponding server side socket retrieved from BluetoothAdapter.retrieveConnectedRfcommSocket(UUID) do not support reads and writes from different threads. Once reading or writing is started for a given socket on a given thread, that type of operation on that socket must only be done on that thread.
    
    Returns:
    
    a server side BluetoothSocket or null if the UUID is not registered. This value should generally not be used directly, and is mainly used to obtain a shadow with which a RFCOMM client can be simulated.
    
    Throws:
    
    IllegalArgumentException - if a server is not started for the given UUID.
    
    PendingIntent.CanceledException - if the pending intent for the server socket was cancelled.
  - getRegisteredRfcommServerUuids
```
public Set<UUID> getRegisteredRfcommServerUuids()
```
    Returns an immutable set of UUIDs representing the currently registered RFCOMM servers.

Class ShadowBluetoothAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RFCOMM_LISTENER_START_FAILED_UUID_IN_USE

RFCOMM_LISTENER_OPERATION_FAILED_NO_MATCHING_SERVICE_RECORD

RFCOMM_LISTENER_FAILED_TO_CLOSE_SERVER_SOCKET

Constructor Detail

ShadowBluetoothAdapter

Method Detail

reset

getDefaultAdapter

createAdapter

setIsBluetoothSupported

setBluetoothLeAdvertiser

getRemoteDevice

getBondedDevices

setBondedDevices

listenUsingInsecureRfcommWithServiceRecord

listenUsingRfcommWithServiceRecord

listenUsingInsecureL2capChannel

listenUsingL2capChannel

startDiscovery

cancelDiscovery

isBleScanAlwaysAvailable

getLeState

startLeScan

startLeScan

stopLeScan

getLeScanCallbacks

getSingleLeScanCallback

isDiscovering

isEnabled

enable

disable

getAddress

getState

getName

setName

setScanMode

setScanMode

setScanMode

getScanMode

getDiscoverableTimeout

setDiscoverableTimeout

setDiscoverableTimeout

isMultipleAdvertisementSupported

checkBluetoothAddress

getProfileConnectionState

setAddress

setState

setEnabled

setBleScanAlwaysAvailable

setIsMultipleAdvertisementSupported

setProfileConnectionState

setProfileProxy

hasActiveProfileProxy

getProfileProxy

closeProfileProxy

isLeExtendedAdvertisingSupported

setIsLeExtendedAdvertisingSupported

getLeMaximumAdvertisingDataLength

startRfcommServer

stopRfcommServer

retrieveConnectedRfcommSocket

addIncomingRfcommConnection

getRegisteredRfcommServerUuids