# WifiDeviceFilter.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/WifiDeviceFilter.Builder "View this page in Java")  

```
class Builder
```

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

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

## Summary

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

|                                                                                                                                                                                                                                                                                             Public methods                                                                                                                                                                                                                                                                                              ||
|------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [WifiDeviceFilter](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter)                  | [build](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#build())`()` Builds the instance.                                                                                                                                                                                                                                                                                                                                             |
| [WifiDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#) | [setBssid](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#setBssid(android.net.MacAddress))`(`value:` `[MacAddress](https://developer.android.com/reference/kotlin/android/net/MacAddress.html#)`)` If set, only devices with BSSID matching the given one will be shown                                                                                                                                                             |
| [WifiDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#) | [setBssidMask](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#setBssidMask(android.net.MacAddress))`(`value:` `[MacAddress](https://developer.android.com/reference/kotlin/android/net/MacAddress.html#)`)` If set, only bits at positions set in this mask, will be compared to the given[BSSID](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#setBssid(android.net.MacAddress))filter. |
| [WifiDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#) | [setNamePattern](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#setNamePattern(java.util.regex.Pattern))`(`value:` `[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                                  |

## Public constructors

### Builder

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

```
Builder()
```

## Public methods

### build

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

```
fun build(): WifiDeviceFilter
```

Builds the instance. This builder should not be touched after calling this!

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

### setBssid

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

```
fun setBssid(value: MacAddress): WifiDeviceFilter.Builder
```

If set, only devices with BSSID matching the given one will be shown

|                                                           Parameters                                                           ||
|---------|-----------------------------------------------------------------------------------------------------------------------|
| `value` | [MacAddress](https://developer.android.com/reference/kotlin/android/net/MacAddress.html#):This value cannot be`null`. |

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

### setBssidMask

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

```
fun setBssidMask(value: MacAddress): WifiDeviceFilter.Builder
```

If set, only bits at positions set in this mask, will be compared to the given[BSSID](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.Builder#setBssid(android.net.MacAddress))filter.

|                                                           Parameters                                                           ||
|---------|-----------------------------------------------------------------------------------------------------------------------|
| `value` | [MacAddress](https://developer.android.com/reference/kotlin/android/net/MacAddress.html#):This value cannot be`null`. |

|                                                                       Return                                                                        ||
|------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [WifiDeviceFilter.Builder](https://developer.android.com/reference/kotlin/android/companion/WifiDeviceFilter.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(value: Pattern?): WifiDeviceFilter.Builder
```

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

|                                                         Parameters                                                         ||
|---------|-------------------------------------------------------------------------------------------------------------------|
| `value` | [Pattern](https://developer.android.com/reference/kotlin/java/util/regex/Pattern.html#)?:This value may be`null`. |

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