InfoRequest (cococlientsdk-java 0.28.2 API)

java.lang.Object
- buzz.getcoco.iot.InfoRequest

```
public class InfoRequest
extends java.lang.Object
```
This class holds request in form of key-value pairs for keys as in the Parameter.Key and sent to a device.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`InfoRequest.BrandSearchCriteria` This class carries information whether the brand search is made for TV/AC.
`static class`	`InfoRequest.ContentPlayback` This class forms a value of request corresponding to `Parameter.Key.CONTENT_PLAYBACK`.
`static class`	`InfoRequest.ContentSearch` This class forms a value of request corresponding to `Parameter.Key.CONTENT_SEARCH`.
`static class`	`InfoRequest.ListenPort` This class forms a value of request corresponding to `Parameter.Key.AVAIL_LISTEN_PORT`.
`static class`	`InfoRequest.RemoteButtonInfo` This class acts as value of request corresponding to `Parameter.Key.REMOTE_BUTTON_INFO`.
`static class`	`InfoRequest.RemotePairingCapabilities` This class acts as a value of request corresponding to `Parameter.Key.REMOTE_PAIR_CAPABILITIES`.
`static class`	`InfoRequest.RemotePairingCode` This class acts as a value of request corresponding to `Parameter.Key.REMOTE_PAIRING_CODES`.
`static class`	`InfoRequest.Search` This class acts as a value of request corresponding to `Parameter.Key.REMOTE_SEARCH`.
`static interface`	`InfoRequest.SearchCriteria` A marker interface to classify search criteria.
`static class`	`InfoRequest.SortOrder` An enum denoting possible sorting order options.
`static class`	`InfoRequest.SortType` An enum denoting possible type of sort options.
`static class`	`InfoRequest.UserDefined` This class forms a value of request corresponding to `Parameter.Key.USER_DEFINED`.
`static interface`	`InfoRequest.Value` A marker interface for values corresponding to key as in `Parameter.Key` for InfoRequest.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`cmdSeqNum` Command sequence number.
`protected long`	`deviceNodeId` ID of device to which either request being sent or received.
`java.util.List<Parameter<InfoRequest.Value>>`	`mandatoryParameters` `Parameter` to which device must respond.
`java.lang.String`	`messageText` The message that has to be passed along with the request.
`protected java.lang.String`	`networkId` Network ID of network to which device belongs to.
`java.util.List<Parameter<InfoRequest.Value>>`	`optionalParameters` `Parameter` to which device might respond.
`protected long`	`requestId` ID of this request.
`protected Command.State`	`state` State of this Info request.
`long`	`timeout` Timeout of the request.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`InfoRequest(java.lang.String messageText, java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters)` A class to request information from a device.
	`InfoRequest(java.lang.String messageText, java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters, java.util.List<Parameter<InfoRequest.Value>> optionalParameters)` A class to request information from a device.
`protected`	`InfoRequest(java.lang.String networkId, long deviceNodeId, java.lang.String messageText, java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters, java.util.List<Parameter<InfoRequest.Value>> optionalParameters)` A class to request information from a device.
`protected`	`InfoRequest(java.lang.String networkId, long deviceNodeId, java.lang.String messageText, long timeout, java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters, java.util.List<Parameter<InfoRequest.Value>> optionalParameters)` A class to request information from a device.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getCmdSeqNum()` A function to get command sequence number.
`Device`	`getDevice()` A function to get `Device` of the info request that was used/will be used.
`long`	`getRequestId()` A function to get request ID.
`Command.State`	`getState()` A function to get state of request.
`long`	`getTimeout()` A function to get time out for the request.
`Parameter.Key[]`	`mandatoryKeys()` A function to create/extract mandatory keys which should be responded from mandatory parameters.
`Parameter.Key[]`	`optionalKeys()` A function to get optional parameters.
`void`	`setTimeout(long timeout)` A function to set time out for request.
`protected com.google.gson.JsonElement`	`toJson()` A function to convert this object into json element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - state
```
protected transient Command.State state
```
    State of this Info request.
  - requestId
```
protected transient long requestId
```
    ID of this request.
  - cmdSeqNum
```
protected transient long cmdSeqNum
```
    Command sequence number.
  - networkId
```
protected transient java.lang.String networkId
```
    Network ID of network to which device belongs to.
  - deviceNodeId
```
protected transient long deviceNodeId
```
    ID of device to which either request being sent or received.
  - timeout
```
public long timeout
```
    Timeout of the request.
  - messageText
```
public final java.lang.String messageText
```
    The message that has to be passed along with the request.
  - mandatoryParameters
```
public final java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters
```
    Parameter to which device must respond.
  - optionalParameters
```
public final java.util.List<Parameter<InfoRequest.Value>> optionalParameters
```
    Parameter to which device might respond.
- Constructor Detail
  - InfoRequest
```
public InfoRequest(java.lang.String messageText,
                   java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters)
```
    A class to request information from a device.
    
    Parameters:
    
    messageText - The message that has to be passed along with the request
    
    mandatoryParameters - The params which must be responded
  - InfoRequest
```
public InfoRequest(java.lang.String messageText,
                   java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters,
                   java.util.List<Parameter<InfoRequest.Value>> optionalParameters)
```
    A class to request information from a device.
    
    Parameters:
    
    messageText - The message that has to be passed along with the request
    
    mandatoryParameters - The params which must be responded
    
    optionalParameters - The params which are optional to respond
  - InfoRequest
```
protected InfoRequest(java.lang.String networkId,
                      long deviceNodeId,
                      java.lang.String messageText,
                      java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters,
                      java.util.List<Parameter<InfoRequest.Value>> optionalParameters)
```
    A class to request information from a device.
    
    Parameters:
    
    networkId - The network to which the device belongs will respond
    
    deviceNodeId - The device which has to respond to this request
    
    messageText - The message that has to be passed along with the request
    
    mandatoryParameters - The params which must be responded
    
    optionalParameters - The params which are optional to respond
  - InfoRequest
```
protected InfoRequest(java.lang.String networkId,
                      long deviceNodeId,
                      java.lang.String messageText,
                      long timeout,
                      java.util.List<Parameter<InfoRequest.Value>> mandatoryParameters,
                      java.util.List<Parameter<InfoRequest.Value>> optionalParameters)
```
    A class to request information from a device.
    
    Parameters:
    
    networkId - The network to which the device belongs will respond
    
    deviceNodeId - The device which has to respond to this request
    
    messageText - The message that has to be passed along with the request
    
    timeout - The timeout after which the command will return fail
    
    mandatoryParameters - The params which must be responded
    
    optionalParameters - The params which are optional to respond
- Method Detail
  - getDevice
```
public Device getDevice()
```
    A function to get Device of the info request that was used/will be used.
    
    Returns:
    
    Device.
  - getCmdSeqNum
```
public long getCmdSeqNum()
```
    A function to get command sequence number.
    
    Returns:
    
    cmdSeqNum.
  - getRequestId
```
public long getRequestId()
```
    A function to get request ID.
    
    Returns:
    
    requestId.
  - getState
```
public Command.State getState()
```
    A function to get state of request.
    
    Returns:
    
    state.
  - mandatoryKeys
```
public Parameter.Key[] mandatoryKeys()
```
    A function to create/extract mandatory keys which should be responded from mandatory parameters.
    
    Returns:
    
    keys which are mandatory to be responded.
  - optionalKeys
```
public Parameter.Key[] optionalKeys()
```
    A function to get optional parameters.
    
    Returns:
    
    an array of keys registered in optional parameters
  - getTimeout
```
public long getTimeout()
```
    A function to get time out for the request.
    
    Returns:
    
    timeout.
  - setTimeout
```
public void setTimeout(long timeout)
```
    A function to set time out for request.
    
    Parameters:
    
    timeout - timeout.
  - toJson
```
protected com.google.gson.JsonElement toJson()
```
    A function to convert this object into json element.
    
    Returns:
    
    json element.

Class InfoRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

state

requestId

cmdSeqNum

networkId

deviceNodeId

timeout

messageText

mandatoryParameters

optionalParameters

Constructor Detail

InfoRequest

InfoRequest

InfoRequest

InfoRequest

Method Detail

getDevice

getCmdSeqNum

getRequestId

getState

mandatoryKeys

optionalKeys

getTimeout

setTimeout

toJson