Stay organized with collections
Save and categorize content based on your preferences.
DeviceId.Builder
public
static
final
class
DeviceId.Builder
extends Object
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
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public constructors
Builder
public Builder ()
Public methods
setCustomId
public DeviceId.Builder setCustomId (String customId)
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. |
setMacAddress
public DeviceId.Builder setMacAddress (MacAddress macAddress)
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. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-13 UTC."],[],[],null,["# DeviceId.Builder\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nDeviceId.Builder\n================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/companion/DeviceId.Builder \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nDeviceId.Builder\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.companion.DeviceId.Builder |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA builder for [DeviceId](/reference/android/companion/DeviceId)\n\nCalling apps must provide at least one of the following to identify\nthe device: a custom ID using [setCustomId(java.lang.String)](/reference/android/companion/DeviceId.Builder#setCustomId(java.lang.String)), or a MAC address using\n[setMacAddress(android.net.MacAddress)](/reference/android/companion/DeviceId.Builder#setMacAddress(android.net.MacAddress)).\n\n\u003cbr /\u003e\n\nSummary\n-------\n\n| ### Public constructors ||\n|----------------------------------------------------------------------------|---|\n| ` `[Builder](/reference/android/companion/DeviceId.Builder#Builder())`() ` |\n\n| ### Public methods ||\n|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[DeviceId](/reference/android/companion/DeviceId) | ` `[build](/reference/android/companion/DeviceId.Builder#build())`() ` |\n| ` `[DeviceId.Builder](/reference/android/companion/DeviceId.Builder) | ` `[setCustomId](/reference/android/companion/DeviceId.Builder#setCustomId(java.lang.String))`(`[String](/reference/java/lang/String)` customId) ` Sets the custom device id. |\n| ` `[DeviceId.Builder](/reference/android/companion/DeviceId.Builder) | ` `[setMacAddress](/reference/android/companion/DeviceId.Builder#setMacAddress(android.net.MacAddress))`(`[MacAddress](/reference/android/net/MacAddress)` macAddress) ` Sets the mac address. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic constructors\n-------------------\n\n### Builder\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Builder ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### build\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic DeviceId build ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------------------|-------------------------------------|\n| [DeviceId](/reference/android/companion/DeviceId) | This value cannot be `null`. \u003cbr /\u003e |\n\n### setCustomId\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic DeviceId.Builder setCustomId (String customId)\n```\n\nSets the custom device id. This id is used by the Companion app to\nidentify a specific device.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|------------|-----------------------------------------------------------------|\n| `customId` | `String`: the custom device id This value may be `null`. \u003cbr /\u003e |\n\n| Returns ||\n|-------------------------------------------------------------------|-------------------------------------|\n| [DeviceId.Builder](/reference/android/companion/DeviceId.Builder) | This value cannot be `null`. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| [IllegalArgumentException](/reference/java/lang/IllegalArgumentException) | length of the custom id must more than 1024 characters to save disk space. |\n\n### setMacAddress\n\nAdded in [API level 36](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic DeviceId.Builder setMacAddress (MacAddress macAddress)\n```\n\nSets the mac address. This mac address is used by the Companion app to\nidentify a specific device.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------|\n| `macAddress` | `MacAddress`: the remote device mac address This value may be `null`. \u003cbr /\u003e |\n\n| Returns ||\n|-------------------------------------------------------------------|-------------------------------------|\n| [DeviceId.Builder](/reference/android/companion/DeviceId.Builder) | This value cannot be `null`. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| [IllegalArgumentException](/reference/java/lang/IllegalArgumentException) | length of the custom id must more than 1024 characters to save disk space. |"]]
