Action Required! Starting November 21st, 2022, Nest Hubs opted into the Preview Program are being updated to support Matter 1.0 in anticipation of Google's general availability (GA) of Matter. All Matter devices being used with the Preview Program will need to be updated. See the Release Notes for more details.

CommissioningCompleteMetadata.Builder

Stay organized with collections Save and categorize content based on your preferences.
public static final class CommissioningCompleteMetadata.Builder extends Object

Builder class to generate CommissioningCompleteMetadata instances.

Public Constructor Summary

Public Method Summary

CommissioningCompleteMetadata
build()
Builds a new instance of CommissioningCompleteMetadata.
String
getDeviceNameHint()
Returns the device name hint set on this builder.
List<Room>
getRooms()
Returns the rooms set on this builder.
String
getToken()
Returns the token set on this builder, if any.
CommissioningCompleteMetadata.Builder
setDeviceNameHint(String deviceNameHint)
Sets a suggested name for the device that was just commissioned.
CommissioningCompleteMetadata.Builder
setRooms(List<Room> rooms)
Sets the list of rooms to be displayed to the user to choose from.
CommissioningCompleteMetadata.Builder
setToken(String token)
Sets an opaque token to identify the device which was just commissioned.

Inherited Method Summary

Public Constructors

public Builder ()

Public Methods

public CommissioningCompleteMetadata build ()

Builds a new instance of CommissioningCompleteMetadata.

public String getDeviceNameHint ()

Returns the device name hint set on this builder.

public List<Room> getRooms ()

Returns the rooms set on this builder.

public String getToken ()

Returns the token set on this builder, if any.

public CommissioningCompleteMetadata.Builder setDeviceNameHint (String deviceNameHint)

Sets a suggested name for the device that was just commissioned. This name will be displayed to the user, and the user will be able to modify the suggestion. If a suggestion was already provided via CommissioningRequest.getDeviceNameHint(), then a suggestion made here will override that value.

Parameters
deviceNameHint a name suggestion for the device, or null to use a generated default
Returns
  • this builder

public CommissioningCompleteMetadata.Builder setRooms (List<Room> rooms)

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 setToken (String token)

Sets an opaque token to identify the device which was just commissioned. This is optional, and will provided verbatim in the 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