buzz.getcoco.iot

Class CapabilityRemoteControl.AddAppliance

java.lang.Object

buzz.getcoco.iot.Command<CapabilityRemoteControl.CommandId>

buzz.getcoco.iot.CapabilityRemoteControl.AddAppliance

Enclosing class:

CapabilityRemoteControl

public static class CapabilityRemoteControl.AddAppliance
extends Command<CapabilityRemoteControl.CommandId>

This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) to add appliance.

Nested Class Summary

Nested classes/interfaces inherited from class buzz.getcoco.iot.Command

Command.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEARN_MODE_BRAND_ID Brand ID for appliances which are added using CapabilityRemoteControl.ProgramMode.LEARN_MODE.
static int	LEARN_MODE_PAIRING_CODE Paring code for appliances which are added using CapabilityRemoteControl.ProgramMode.LEARN_MODE.

Method Summary

Modifier and Type	Method and Description
static CapabilityRemoteControl.AddAppliance	forLearnMode(java.lang.String applianceName, CapabilityRemoteControl.Category category) Convenience function for getting CapabilityRemoteControl.AddAppliance for learn mode.
static CapabilityRemoteControl.AddAppliance	forPresetMode(java.lang.String applianceName, CapabilityRemoteControl.Category category, int brandId, int pairingCode) Convenience function for getting CapabilityRemoteControl.AddAppliance for preset mode.
static CapabilityRemoteControl.AddAppliance	forSearchMode(java.lang.String applianceName, CapabilityRemoteControl.Category category, int brandId, int pairingCode) Convenience function for getting CapabilityRemoteControl.AddAppliance for search mode.
java.lang.String	getApplianceName() A function to get applianceName.
int	getBrandId() A function to get brandId of appliance.
CapabilityRemoteControl.Category	getCategory() A function to get category.
CapabilityRemoteControl.ProgramMode	getMode() A function to get mode.
int	getPairingCode() A function to get pairingCode of appliance.

Methods inherited from class buzz.getcoco.iot.Command

getCommandId, getTimeout, setCommandId, setTimeout, toJsonObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LEARN_MODE_PAIRING_CODE

public static final int LEARN_MODE_PAIRING_CODE

Paring code for appliances which are added using CapabilityRemoteControl.ProgramMode.LEARN_MODE.

See Also:

Constant Field Values

LEARN_MODE_BRAND_ID

public static final int LEARN_MODE_BRAND_ID

Brand ID for appliances which are added using CapabilityRemoteControl.ProgramMode.LEARN_MODE.

See Also:

Constant Field Values

Method Detail

forPresetMode

public static CapabilityRemoteControl.AddAppliance forPresetMode(java.lang.String applianceName,
                                                                 CapabilityRemoteControl.Category category,
                                                                 int brandId,
                                                                 int pairingCode)

Convenience function for getting CapabilityRemoteControl.AddAppliance for preset mode.

Parameters:

applianceName - Name of the appliance

category - CapabilityRemoteControl.Category of the appliance

brandId - The brand id from InfoResponse.BrandSearchResults

pairingCode - The pairing code from InfoResponse.RemotePairingCode

Returns:

AddAppliance command which can be used

forSearchMode

public static CapabilityRemoteControl.AddAppliance forSearchMode(java.lang.String applianceName,
                                                                 CapabilityRemoteControl.Category category,
                                                                 int brandId,
                                                                 int pairingCode)

Convenience function for getting CapabilityRemoteControl.AddAppliance for search mode.

Parameters:

applianceName - Name of the appliance

category - CapabilityRemoteControl.Category of the appliance

brandId - The brand id from InfoResponse.BrandSearchResults

pairingCode - The pairing code from CapabilityRemoteControl.SetSearchModeResponse

Returns:

AddAppliance command which can be used

forLearnMode

public static CapabilityRemoteControl.AddAppliance forLearnMode(java.lang.String applianceName,
                                                                CapabilityRemoteControl.Category category)

Convenience function for getting CapabilityRemoteControl.AddAppliance for learn mode.

Parameters:

applianceName - Name of the appliance

category - CapabilityRemoteControl.Category of the appliance

Returns:

AddAppliance command which can be used

getBrandId

public int getBrandId()

A function to get brandId of appliance.

Note: In case appliance is added through CapabilityRemoteControl.ProgramMode.LEARN_MODE, value needs to be LEARN_MODE_BRAND_ID.

Returns:

BrandId.

getPairingCode

public int getPairingCode()

A function to get pairingCode of appliance.

Note: In case appliance is added through CapabilityRemoteControl.ProgramMode.LEARN_MODE, value needs to be LEARN_MODE_PAIRING_CODE.

Returns:

Paring code.

getApplianceName

public java.lang.String getApplianceName()

A function to get applianceName.

Returns:

Appliance name.

getCategory

public CapabilityRemoteControl.Category getCategory()

A function to get category.

Returns:

CapabilityRemoteControl.Category to which this appliance belongs to.

getMode

public CapabilityRemoteControl.ProgramMode getMode()

A function to get mode.

Returns:

CapabilityRemoteControl.ProgramMode through which appliance needs to be added.