buzz.getcoco.iot

Class CapabilityRemoteControl

java.lang.Object

buzz.getcoco.iot.Capability

buzz.getcoco.iot.CapabilityRemoteControl

All Implemented Interfaces:

java.lang.Iterable<Attribute>

public class CapabilityRemoteControl
extends Capability

This class describes Commands and Attributes for Remote Control Capability of a Resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilityRemoteControl.AddAppliance 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.
static class	CapabilityRemoteControl.AddApplianceResponse Class useful in binding json response to object.
static class	CapabilityRemoteControl.AttributeId enum denoting various possible attributes of the CapabilityRemoteControl.
static class	CapabilityRemoteControl.CancelLearnMode This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending cancel learn mode command.
static class	CapabilityRemoteControl.Category possible values for CapabilityRemoteControl.AttributeId.CATEGORY_ID_ARR.
static class	CapabilityRemoteControl.CommandId enum denoting the possible Commands that can be sent for CapabilityRemoteControl.
static class	CapabilityRemoteControl.EnterLearnMode This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending enter learn mode command.
static class	CapabilityRemoteControl.ExecuteCommand<T extends Command<? extends Capability.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 execute commands.
static class	CapabilityRemoteControl.ExecuteLearnedCommand This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending execute learnt command.
static class	CapabilityRemoteControl.ProgramMode possible values for CapabilityRemoteControl.AttributeId.SUPPORTED_PROGRAM_MODES_ARR.
static class	CapabilityRemoteControl.RemoteControlButtonInfo Json structure for elements of attribute value of CapabilityRemoteControl.AttributeId.APPLIANCE_LIST.
static class	CapabilityRemoteControl.RemoveAppliance This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending remove appliances command.
static class	CapabilityRemoteControl.RemoveButton This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending remove button command.
static class	CapabilityRemoteControl.RenameButton This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending rename button command.
static class	CapabilityRemoteControl.SaveLearnedCommand This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending save learned command.
static class	CapabilityRemoteControl.SetApplianceName This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending set name for appliances command.
static class	CapabilityRemoteControl.SetAppliancePairingCode This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while setting pairing code for appliances.
static class	CapabilityRemoteControl.SetSearchMode This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending set search mode command.
static class	CapabilityRemoteControl.SetSearchModeResponse Class useful in binding json response to object.
static class	CapabilityRemoteControl.TestCommand<T extends Command<? extends Capability.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 test command to IR Blaster.
static class	CapabilityRemoteControl.TestLearnedCommand This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending test learned command.

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

Capability.CapabilityId, Capability.CommandStatusListener<T extends Capability.CommandId>

Field Summary

Fields

Modifier and Type	Field and Description
static Capability.CapabilityId	ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapabilityRemoteControl(int id, Resource parent) Constructor of the current class.

Method Summary

Modifier and Type	Method and Description
protected <T extends CommandIdInterface> CommandResponse.Args<T>	createCommandResponseArgs(T commandId, com.google.gson.JsonElement jsonResponse) create response for the command.
protected Command<? extends Capability.CommandId>	extendedCreateCommand(int primitiveCommandId, com.google.gson.JsonElement commandParams) A function to create the command from the Json params.
void	searchBrands(int searchCount, int offsetIndex, Parameter.SearchType st, InfoRequest.SortOrder so, InfoRequest.SortType soT, CapabilityRemoteControl.Category cat, java.lang.String brandSearchQuery, Device.InfoRequestStatusListener cbs) A function to make an info request for search program mode.
boolean	supports(Capability.CommandId commandId) This function is used to check if a command is supported by the capability or not.

Methods inherited from class buzz.getcoco.iot.Capability

clearAndSetStandardCommandSet, containsAttribute, containsAttribute, createCommand, getAttribute, getAttribute, getAttributeMap, getCapabilityWrapper, getId, getName, getParent, getSupportedCommands, hashCode, interceptCommand, internalAddAttribute, internalMarkAsReady, internalRemoveAttribute, internalSetName, internalSetParent, isReady, iterator, sendResourceCommand, setCapabilityWrapper, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ID

public static final Capability.CapabilityId ID

Constructor Detail

CapabilityRemoteControl

protected CapabilityRemoteControl(int id,
                                  Resource parent)

Constructor of the current class.

Parameters:

id - The unique id Of the capability

parent - The parent Resource of the capability.

Method Detail

supports

public boolean supports(Capability.CommandId commandId)

This function is used to check if a command is supported by the capability or not.

Overrides:

supports in class Capability

Parameters:

commandId - The Id denoting the command to be sent.

Returns:

boolean: If the command is supported then True is returned.

extendedCreateCommand

protected Command<? extends Capability.CommandId> extendedCreateCommand(int primitiveCommandId,
                                                                        com.google.gson.JsonElement commandParams)

A function to create the command from the Json params.

Specified by:

extendedCreateCommand in class Capability

Parameters:

primitiveCommandId - The int form of the commandId

commandParams - The Json params that can form a command

Returns:

The command which is formed

createCommandResponseArgs

protected <T extends CommandIdInterface> CommandResponse.Args<T> createCommandResponseArgs(T commandId,
                                                                                           com.google.gson.JsonElement jsonResponse)

create response for the command.

Overrides:

createCommandResponseArgs in class Capability

Parameters:

commandId - The command ID which has to be responded

jsonResponse - The response body

Returns:

The created response

See Also:

CommandResponse.Args

searchBrands

public void searchBrands(int searchCount,
                         int offsetIndex,
                         Parameter.SearchType st,
                         InfoRequest.SortOrder so,
                         InfoRequest.SortType soT,
                         CapabilityRemoteControl.Category cat,
                         java.lang.String brandSearchQuery,
                         Device.InfoRequestStatusListener cbs)

A function to make an info request for search program mode.

Parameters:

searchCount - Search count for info request

offsetIndex - offset provided for search request

st - Search type (Brand)

so - Sort order (Ascending/Descending)

soT - Sort type (Ex: sort by time of creation)

cat - Category of the command (AC/TV)

brandSearchQuery - a string param for brand search criteria

cbs - Listener that receives status of info request made