Added in API level Baklava
Builder
class Builder
| kotlin.Any | |
| ↳ | android.companion.DeviceId.Builder |
A builder for DeviceId
Calling apps must provide at least one of the following to identify the device: a custom ID using setCustomId(java.lang.String), or a MAC address using setMacAddress(android.net.MacAddress).
Summary
| Public constructors | |
|---|---|
Builder() |
|
| Public methods | |
|---|---|
| DeviceId |
build() |
| DeviceId.Builder |
setCustomId(customId: String?)Sets the custom device id. |
| DeviceId.Builder |
setMacAddress(macAddress: MacAddress?)Sets the mac address. |
Public constructors
Public methods
setCustomId
Added in API level Baklava
fun setCustomId(customId: String?): DeviceId.Builder
Sets the custom device id. This id is used by the Companion app to identify a specific device.
| Parameters | |
|---|---|
customId |
String?: the custom device id This value may be null. |
| Return | |
|---|---|
DeviceId.Builder |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
length of the custom id must more than 1024 characters to save disk space. |
setMacAddress
Added in API level Baklava
fun setMacAddress(macAddress: MacAddress?): DeviceId.Builder
Sets the mac address. This mac address is used by the Companion app to identify a specific device.
| Parameters | |
|---|---|
macAddress |
MacAddress?: the remote device mac address This value may be null. |
| Return | |
|---|---|
DeviceId.Builder |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
length of the custom id must more than 1024 characters to save disk space. |