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>) while sending add appliance commands.

Nested Class Summary

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

Command.State

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	applianceName
int	brandId
CapabilityRemoteControl.Category	category
static int	LEARN_MODE_BRAND_ID
static int	LEARN_MODE_PAIRING_CODE
CapabilityRemoteControl.ProgramMode	mode
int	pairingCode

Constructor Summary

Constructors

Constructor and Description
AddAppliance(int brandId, int pairingCode, java.lang.String applianceName, CapabilityRemoteControl.Category category, CapabilityRemoteControl.ProgramMode mode) Constructor for AddAppliance command.

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.

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

See Also:

Constant Field Values

LEARN_MODE_BRAND_ID

public static final int LEARN_MODE_BRAND_ID

See Also:

Constant Field Values

brandId

@SerializedName(value="brandId")
public final int brandId

pairingCode

@SerializedName(value="pairingCode")
public final int pairingCode

applianceName

@SerializedName(value="applianceName")
public final java.lang.String applianceName

category

@SerializedName(value="categoryId")
public final CapabilityRemoteControl.Category category

mode

@SerializedName(value="programmingMode")
public final CapabilityRemoteControl.ProgramMode mode

Constructor Detail

AddAppliance

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

Constructor for AddAppliance command.

Parameters:

brandId - integer id of brand

pairingCode - Pairing code generated during pairing

applianceName - name of appliance to be added

category - Category of the command (AC/TV) CapabilityRemoteControl.Category

mode - programming mode applicable CapabilityRemoteControl.Category

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