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.

CommissioningResult.Builder

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

Builder class to create instances of CommissioningResult.

Public Constructor Summary

Public Method Summary

CommissioningResult
build()
Builds an instance of CommissioningResult as configured in this builder.
DeviceDescriptor
getCommissionedDeviceDescriptor()
Returns the device descriptor set on this builder.
String
getDeviceName()
Returns the device name set on this builder.
Room
getRoom()
Returns the room set on this builder.
String
getToken()
Returns the token set on this builder, if any.
CommissioningResult.Builder
setCommissionedDeviceDescriptor(DeviceDescriptor commissionedDeviceDescriptor)
Sets the device descriptor of the commissioned device.
CommissioningResult.Builder
setDeviceName(String deviceName)
Sets the name which was assigned to the commissioned device.
CommissioningResult.Builder
setRoom(Room room)
Sets the room which the user selected, if any.
CommissioningResult.Builder
setToken(String token)
Sets the opaque token associated with this result.

Inherited Method Summary

Public Constructors

public Builder ()

Public Methods

public CommissioningResult build ()

Builds an instance of CommissioningResult as configured in this builder.

Throws
IllegalStateException if the device descriptor, or device name are not set

public DeviceDescriptor getCommissionedDeviceDescriptor ()

Returns the device descriptor set on this builder.

public String getDeviceName ()

Returns the device name set on this builder.

public Room getRoom ()

Returns the room set on this builder.

public String getToken ()

Returns the token set on this builder, if any.

public CommissioningResult.Builder setCommissionedDeviceDescriptor (DeviceDescriptor commissionedDeviceDescriptor)

Sets the device descriptor of the commissioned device.

Returns
  • this builder

public CommissioningResult.Builder setDeviceName (String deviceName)

Sets the name which was assigned to the commissioned device.

Returns
  • this builder

public CommissioningResult.Builder setRoom (Room room)

Sets the room which the user selected, if any.

Returns
  • this builder

public CommissioningResult.Builder setToken (String token)

Sets the opaque token associated with this result.

Returns
  • this builder