# CommissioningCompleteMetadata.Builder

public static final class **CommissioningCompleteMetadata.Builder** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Builder class to generate `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata` instances.

### Public Constructor Summary

|---|---|
|   | [Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#Builder())() |

### Public Method Summary

|---|---|
| [CommissioningCompleteMetadata](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata) | [build](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#build())() Builds a new instance of `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata`. |
| [String](https://developer.android.com/reference/java/lang/String.html) | [getDeviceNameHint](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#getDeviceNameHint())() Returns the device name hint set on this builder. |
| [List](https://developer.android.com/reference/java/util/List.html)\<[Room](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/Room)\> | [getRooms](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#getRooms())() *This method is deprecated. rooms are no longer used in the commissioning flow* |
| [String](https://developer.android.com/reference/java/lang/String.html) | [getToken](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#getToken())() Returns the token set on this builder, if any. |
| [CommissioningCompleteMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder) | [setDeviceNameHint](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#setDeviceNameHint(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) deviceNameHint) Sets a suggested name for the device that was just commissioned. |
| [CommissioningCompleteMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder) | [setRooms](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#setRooms(java.util.List<com.google.android.gms.home.matter.commissioning.Room>))([List](https://developer.android.com/reference/java/util/List.html)\<[Room](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/Room)\> rooms) *This method is deprecated. rooms are no longer used in the commissioning flow* |
| [CommissioningCompleteMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder) | [setToken](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder#setToken(java.lang.String))([String](https://developer.android.com/reference/java/lang/String.html) token) Sets an opaque token to identify the device which was just commissioned. |

### 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 Constructors

#### public **Builder** ()

## Public Methods

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

Builds a new instance of `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata`.

#### public [String](https://developer.android.com/reference/java/lang/String.html) **getDeviceNameHint** ()

Returns the device name hint set on this builder.

#### public [List](https://developer.android.com/reference/java/util/List.html)\<[Room](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/Room)\>
**getRooms** ()

**This method is deprecated.**   

rooms are no longer used in the commissioning flow
Returns the rooms set on this builder.

#### public [String](https://developer.android.com/reference/java/lang/String.html) **getToken** ()

Returns the token set on this builder, if any.

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

Sets a suggested name for the device that was just commissioned. This name may be
used as the name for the device in Android settings. If a suggestion was already
provided via `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningRequest#getDeviceNameHint()`, then a suggestion made here will
override that value.

##### Parameters

| deviceNameHint | a name suggestion for the device, or null to use a default |
|---|---|

##### Returns

- this builder

#### public [CommissioningCompleteMetadata.Builder](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningCompleteMetadata.Builder) **setRooms** ([List](https://developer.android.com/reference/java/util/List.html)\<[Room](https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/Room)\> rooms)

**This method is deprecated.**   

rooms are no longer used in the commissioning flow
Sets the list of rooms to be displayed to the user to choose from. If your
application is not interested in conceptualizing rooms, this may be left empty.

##### Parameters

| rooms | the list of rooms to display to the user |
|---|---|

##### Returns

- this builder

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

Sets an opaque token to identify the device which was just commissioned. This is
optional, and will provided verbatim in the `https://developers.home.google.com/android/reference/com/google/android/gms/home/matter/commissioning/CommissioningResult` provided when the commissioning flow completes.

This can be useful if you need to propagate an identifier from your commissioning
service to your UI layer.

##### Returns

- this builder