Parameter.Key (cococlientsdk-java 0.28.2 API)

java.lang.Object
- java.lang.Enum<Parameter.Key>
- - buzz.getcoco.iot.Parameter.Key

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Parameter.Key>

Enclosing class:

Parameter<T extends buzz.getcoco.iot.Parameter.Value>
```
public static enum Parameter.Key
extends java.lang.Enum<Parameter.Key>
```
An enum denoting possible keys for Info request and Info response. NOTE: when adding a new key make sure that appropriate classes are added into InfoResponse, InfoRequest and those classes are added into InfoRequest.PARAM_CLASS_LUT InfoResponse.PARAM_CLASS_LUT.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AVAIL_LISTEN_PORT` Key to request a device providing tunnel capability for list of available listen ports that are acceptable for tunnel connection.
`CONTENT_PLAYBACK` Key to use when requesting content playback url.
`CONTENT_SEARCH` Key to request content search using URI from a storage node.
`CSA` The CSA key that is usually (but not limited) requested during add resource flow.
`DSK` The DSK key that is usually (but not limited) requested during add resource flow.
`INSTALL_CODE` The installation code key that is usually (but not limited) requested during add resource flow.
`OTP` The otp key that is usually (but not limited) requested during add resource flow.
`PAIRING_TYPE` Key that's used to determine the `Parameter.PairingType` to use in addition flow.
`PASSWORD` The password key that is sometimes (but not limited) requested along with username to authenticate the user during add resource flow.
`PIN` The pin key that is usually (but not limited) requested during add resource flow.
`REMOTE_BUTTON_INFO` Key used in request to retrieve remote buttons info using applianceID and resourceEui from a `CapabilityRemoteControl`.
`REMOTE_PAIR_CAPABILITIES` Key used to request pairing capability id and attribute ids from a `Device / CocoClient`.
`REMOTE_PAIRING_CODES` Key used in request for remote pairing code using brand ID and category of resource from a `CapabilityRemoteControl`.
`REMOTE_SEARCH` Key used in request search and retrieve search results.
`RESOURCE_NAME` The resource name key that is often requested during add resource flow.
`STREAM_BUFFER_SIZES` Currently not in use.
`TIMEZONE` Key that's requested during resource addition to determine th timezone of the client.
`USER_DEFINED` A user-defined key for customized use cases.
`USERNAME` The username key that is sometimes (but not limited) requested to identify the user during add resource flow.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Parameter.Key`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Parameter.Key[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - USER_DEFINED
```
public static final Parameter.Key USER_DEFINED
```
    A user-defined key for customized use cases.
  - USERNAME
```
public static final Parameter.Key USERNAME
```
    The username key that is sometimes (but not limited) requested to identify the user during add resource flow.
  - PASSWORD
```
public static final Parameter.Key PASSWORD
```
    The password key that is sometimes (but not limited) requested along with username to authenticate the user during add resource flow.
  - PIN
```
public static final Parameter.Key PIN
```
    The pin key that is usually (but not limited) requested during add resource flow.
  - OTP
```
public static final Parameter.Key OTP
```
    The otp key that is usually (but not limited) requested during add resource flow.
  - INSTALL_CODE
```
public static final Parameter.Key INSTALL_CODE
```
    The installation code key that is usually (but not limited) requested during add resource flow.
  - CSA
```
public static final Parameter.Key CSA
```
    The CSA key that is usually (but not limited) requested during add resource flow.
  - DSK
```
public static final Parameter.Key DSK
```
    The DSK key that is usually (but not limited) requested during add resource flow.
  - RESOURCE_NAME
```
public static final Parameter.Key RESOURCE_NAME
```
    The resource name key that is often requested during add resource flow.
  - AVAIL_LISTEN_PORT
```
public static final Parameter.Key AVAIL_LISTEN_PORT
```
    Key to request a device providing tunnel capability for list of available listen ports that are acceptable for tunnel connection.
  - CONTENT_SEARCH
```
public static final Parameter.Key CONTENT_SEARCH
```
    Key to request content search using URI from a storage node.
  - CONTENT_PLAYBACK
```
public static final Parameter.Key CONTENT_PLAYBACK
```
    Key to use when requesting content playback url.
  - STREAM_BUFFER_SIZES
```
public static final Parameter.Key STREAM_BUFFER_SIZES
```
    Currently not in use.
  - PAIRING_TYPE
```
public static final Parameter.Key PAIRING_TYPE
```
    Key that's used to determine the Parameter.PairingType to use in addition flow.
  - TIMEZONE
```
public static final Parameter.Key TIMEZONE
```
    Key that's requested during resource addition to determine th timezone of the client.
  - REMOTE_PAIRING_CODES
```
public static final Parameter.Key REMOTE_PAIRING_CODES
```
    Key used in request for remote pairing code using brand ID and category of resource from a CapabilityRemoteControl.
  - REMOTE_PAIR_CAPABILITIES
```
public static final Parameter.Key REMOTE_PAIR_CAPABILITIES
```
    Key used to request pairing capability id and attribute ids from a Device / CocoClient.
  - REMOTE_BUTTON_INFO
```
public static final Parameter.Key REMOTE_BUTTON_INFO
```
    Key used in request to retrieve remote buttons info using applianceID and resourceEui from a CapabilityRemoteControl.
  - REMOTE_SEARCH
```
public static final Parameter.Key REMOTE_SEARCH
```
    Key used in request search and retrieve search results.
- Method Detail
  - values
```
public static Parameter.Key[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Parameter.Key c : Parameter.Key.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Parameter.Key valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum Parameter.Key

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

USER_DEFINED

USERNAME

PASSWORD

PIN

OTP

INSTALL_CODE

CSA

DSK

RESOURCE_NAME

AVAIL_LISTEN_PORT

CONTENT_SEARCH

CONTENT_PLAYBACK

STREAM_BUFFER_SIZES

PAIRING_TYPE

TIMEZONE

REMOTE_PAIRING_CODES

REMOTE_PAIR_CAPABILITIES

REMOTE_BUTTON_INFO

REMOTE_SEARCH

Method Detail

values

valueOf