# SharedDeviceData.Builder

public static final class **SharedDeviceData.Builder** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
A builder for `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData`
instances. Acquire an instance via `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData#builder(java.lang.String)`.

### Public Method Summary

|---|---|
| [SharedDeviceData](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData) | [build](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#build())() Constructs an instance of `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData` from this builder. |
| [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) | [setCommissioningWindowExpirationMillis](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setCommissioningWindowExpirationMillis(long))(long commissioningWindowExpirationMillis) Sets the expiration time of the opened commissioning window. |
| [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) | [setDeviceName](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setDeviceName(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) deviceName) *This method is deprecated. this field is not expected to be populated; the vendor ID and product ID can be used to map to a device type* |
| [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) | [setDeviceType](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setDeviceType(int))(int deviceType) *This method is deprecated. this field is not expected to be populated; the vendor ID and product ID can be used to map to a device type* |
| [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) | [setProductId](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setProductId(int))(int productId) Sets the device's product ID. |
| [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) | [setRoomName](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setRoomName(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) roomName) Sets the user-facing name of the room in which the device is located. |
| [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) | [setVendorId](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setVendorId(int))(int vendorId) Sets the device's vendor ID. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public [SharedDeviceData](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData) **build** ()

Constructs an instance of `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData` from this builder.

##### Throws

| [IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException.html) | if `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setDeviceName(java.lang.String)` was not called |
| [IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException.html) | if `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder#setCommissioningWindowExpirationMillis(long)` was not called |
|---|---|

#### public [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) **setCommissioningWindowExpirationMillis** (long commissioningWindowExpirationMillis)

Sets the expiration time of the opened commissioning window. The time basis must be
`https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()`.

##### Returns

- this builder

##### Throws

| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the value is less than zero |
|---|---|

#### public [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) **setDeviceName** ([String](https://developer.android.com/reference/java/lang/String.html) deviceName)

**This method is deprecated.**   

this field is not expected to be populated; the vendor ID and product ID can be used to
map to a device type
Sets the user-facing name of this device.

##### Returns

- this builder

##### Throws

| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the device name is empty |
|---|---|

#### public [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) **setDeviceType** (int deviceType)

**This method is deprecated.**   

this field is not expected to be populated; the vendor ID and product ID can be used to
map to a device type
Sets the device's primary Matter device type.

##### Returns

- this builder

##### Throws

| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the value is not in \[0,FFFF\] |
|---|---|

#### public [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) **setProductId** (int productId)

Sets the device's product ID.

##### Returns

- this builder

##### Throws

| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the value is not in \[0,FFFF\] |
|---|---|

#### public [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) **setRoomName** ([String](https://developer.android.com/reference/java/lang/String.html) roomName)

Sets the user-facing name of the room in which the device is located. This may be
set to null if there is no room for the device.

##### Returns

- this builder

#### public [SharedDeviceData.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/SharedDeviceData.Builder) **setVendorId** (int vendorId)

Sets the device's vendor ID.

##### Returns

- this builder

##### Throws

| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the value is not in \[0,FFFF\] |
|---|---|