CommissioningCompleteMetadata.Builder

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() This method is deprecated. rooms are no longer used in the commissioning flow
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) This method is deprecated. rooms are no longer used in the commissioning flow
CommissioningCompleteMetadata.Builder	setToken(String token) Sets an opaque token to identify the device which was just commissioned.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

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 ()

This method is deprecated.
rooms are no longer used in the commissioning flow

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 may be used as the name for the device in Android settings. 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 default

Returns

this builder

public CommissioningCompleteMetadata.Builder setRooms (List<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 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