# BluetoothDeviceFilter.Builder

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder "View this page in Java")  

```
class Builder
```

|---|----------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                     ||
| ↳ | [android.companion.BluetoothDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#) |

A builder for[BluetoothDeviceFilter](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter)

## Summary

|                                                        Public constructors                                                        ||
|--------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#Builder())`()` <br /> |

|                                                                                                                                                                                                                                                                                                                                                                                   Public methods                                                                                                                                                                                                                                                                                                                                                                                    ||
|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#)  | [addServiceUuid](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#addServiceUuid(android.os.ParcelUuid,%20android.os.ParcelUuid))`(`serviceUuid:` `[ParcelUuid](https://developer.android.com/reference/kotlin/android/os/ParcelUuid.html#)?`, `serviceUuidMask:` `[ParcelUuid](https://developer.android.com/reference/kotlin/android/os/ParcelUuid.html#)?`)` Add filtering by certain bits of[BluetoothDevice.getUuids()](https://developer.android.com/reference/kotlin/android/bluetooth/BluetoothDevice.html#getUuids())A device with any uuid matching the given bits is considered passing |
| [BluetoothDeviceFilter](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter)                   | [build](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#build())`()` <br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#)  | [setAddress](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#setAddress(kotlin.String))`(`address:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`)` <br />                                                                                                                                                                                                                                                                                                                                                                                                  |
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#)! | [setNamePattern](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#setNamePattern(java.util.regex.Pattern))`(`regex:` `[Pattern](https://developer.android.com/reference/kotlin/java/util/regex/Pattern.html#)?`)` <br />                                                                                                                                                                                                                                                                                                                                                                           |

## Public constructors

### Builder

```
Builder()
```

## Public methods

### addServiceUuid

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun addServiceUuid(
    serviceUuid: ParcelUuid?, 
    serviceUuidMask: ParcelUuid?
): BluetoothDeviceFilter.Builder
```

Add filtering by certain bits of[BluetoothDevice.getUuids()](https://developer.android.com/reference/kotlin/android/bluetooth/BluetoothDevice.html#getUuids())A device with any uuid matching the given bits is considered passing

|                                                                                       Parameters                                                                                        ||
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `serviceUuid`     | [ParcelUuid](https://developer.android.com/reference/kotlin/android/os/ParcelUuid.html#)?:the values for the bits to match This value may be`null`.                  |
| `serviceUuidMask` | [ParcelUuid](https://developer.android.com/reference/kotlin/android/os/ParcelUuid.html#)?:if provided, only those bits would have to match. This value may be`null`. |

|                                                                            Return                                                                             ||
|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#) | This value cannot be`null`. |

### build

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): BluetoothDeviceFilter
```

|                                                                    Return                                                                    ||
|-----------------------------------------------------------------------------------------------------------------|-----------------------------|
| [BluetoothDeviceFilter](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter) | This value cannot be`null`. |

### setAddress

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setAddress(address: String?): BluetoothDeviceFilter.Builder
```

|                                                                                                   Parameters                                                                                                    ||
|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `address` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?:if set, only devices with MAC address exactly matching the given one will pass the filter This value may be`null`. |

|                                                                            Return                                                                             ||
|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder#) | This value cannot be`null`. |

### setNamePattern

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setNamePattern(regex: Pattern?): BluetoothDeviceFilter.Builder!
```

|                                                                                                                                                   Parameters                                                                                                                                                   ||
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `regex` | [Pattern](https://developer.android.com/reference/kotlin/java/util/regex/Pattern.html#)?:if set, only devices with[name](https://developer.android.com/reference/kotlin/android/bluetooth/BluetoothDevice.html#getName())matching the given regular expression will be shown This value may be`null`. |