AWS IoT Device Shadow v1.0.2
AWS IoT Device Shadow client library
Enumerated Types

Enumerated types of the Shadow library. More...

Enumerations

enum  ShadowMessageType_t {
  ShadowMessageTypeGetAccepted = 0 , ShadowMessageTypeGetRejected , ShadowMessageTypeDeleteAccepted , ShadowMessageTypeDeleteRejected ,
  ShadowMessageTypeUpdateAccepted , ShadowMessageTypeUpdateRejected , ShadowMessageTypeUpdateDocuments , ShadowMessageTypeUpdateDelta ,
  ShadowMessageTypeMaxNum
}
 Each of these values describes the type of a shadow message. https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html.
 
enum  ShadowTopicStringType_t {
  ShadowTopicStringTypeGet = 0 , ShadowTopicStringTypeGetAccepted , ShadowTopicStringTypeGetRejected , ShadowTopicStringTypeDelete ,
  ShadowTopicStringTypeDeleteAccepted , ShadowTopicStringTypeDeleteRejected , ShadowTopicStringTypeUpdate , ShadowTopicStringTypeUpdateAccepted ,
  ShadowTopicStringTypeUpdateRejected , ShadowTopicStringTypeUpdateDocuments , ShadowTopicStringTypeUpdateDelta , ShadowTopicStringTypeMaxNum
}
 Each of these values describes the type of a shadow topic string. More...
 
enum  ShadowStatus_t {
  SHADOW_SUCCESS = 0 , SHADOW_FAIL , SHADOW_BAD_PARAMETER , SHADOW_BUFFER_TOO_SMALL ,
  SHADOW_THINGNAME_PARSE_FAILED , SHADOW_SHADOW_MESSAGE_TYPE_PARSE_FAILED
}
 Return codes from Shadow functions. More...
 

Detailed Description

Enumerated types of the Shadow library.

Enumeration Type Documentation

◆ ShadowTopicStringType_t

Each of these values describes the type of a shadow topic string.

These are used for topicType parameter of Shadow_GetTopicString() to tell it what topic string to assemble.

◆ ShadowStatus_t

Return codes from Shadow functions.

Enumerator
SHADOW_SUCCESS 

Shadow function success.

SHADOW_FAIL 

Shadow function encountered error.

SHADOW_BAD_PARAMETER 

Input parameter is invalid.

SHADOW_BUFFER_TOO_SMALL 

The provided buffer is too small.

SHADOW_THINGNAME_PARSE_FAILED 

Could not parse the thing name.

SHADOW_SHADOW_MESSAGE_TYPE_PARSE_FAILED 

Could not parse the shadow type.