This section lists the enumeration types and their definitions for the Agent APIs.

Table 1. Enumeration Types
Enumeration Type Definition
enum IotcValType
{ BOOLEAN, FLOAT, STRING, INTEGER }
Denotes the metric unit type.
enum IotcCampaignState
{ IOTC_CAMPAIGN_INITIALIZED, IOTC_CAMPAIGN_INSTANTIATED, IOTC_CAMPAIGN_INVENTORY_UP_TO_DATE, IOTC_CAMPAIGN_INVENTORY_UPDATE_FAILURE, IOTC_CAMPAIGN_WAITING_FOR_DOWNLOAD_APPROVAL, IOTC_CAMPAIGN_SCHEDULED_DOWNLOAD, IOTC_CAMPAIGN_WAITING_FOR_DOWNLOAD, IOTC_CAMPAIGN_DOWNLOADING, IOTC_CAMPAIGN_DOWNLOAD_COMPLETE, IOTC_CAMPAIGN_DOWNLOAD_FAILED, IOTC_CAMPAIGN_WAITING_FOR_EXECUTION_APPROVAL, IOTC_CAMPAIGN_SCHEDULED_EXECUTION, IOTC_CAMPAIGN_WAITING_TO_EXECUTE, IOTC_CAMPAIGN_EXECUTING, IOTC_CAMPAIGN_EXECUTION_COMPLETE, IOTC_CAMPAIGN_EXECUTION_FAILED, IOTC_CAMPAIGN_WAITING_FOR_ACTIVATION_APPROVAL, IOTC_CAMPAIGN_SCHEDULED_ACTIVATION, IOTC_CAMPAIGN_WAITING_TO_ACTIVATE, IOTC_CAMPAIGN_ACTIVATING, IOTC_CAMPAIGN_ACTIVATION_COMPLETE, IOTC_CAMPAIGN_ACTIVATION_FAILED }
Denotes the supported campaign states.
enum IotcGetResponseMsgType
{ IOTC_GET_DATA_RESPONSE, IOTC_POST_DATA_RESPONSE, IOTC_ENROLL_RESPONSE, IOTC_UNENROLL_RESPONSE, IOTC_CAMPAIGN_STATE_CHANGE, IOTC_SCHEDULE_RESPONSE, IOTC_SET_PROGRESS, IOTC _SEND_METRIC, IOTC_SET_METRIC_INTVL, IOTC_UPLOAD_FILE, IOTC_GET_DATA, IOTC_REGISTER_CB, IOTC_SEND_PROPERTIES, IOTC_NO_RESPONSE }
Denotes the supported response message types.
enum IotcEnrollmentType
{ IOTC_PRE_REGISTERED, IOTC_NOT_REGISTERED }
Denotes the supported enrollment types.
enum boolean
{ FALSE, TRUE }
Denotes the boolean state.
enum IotcMetricType
{ IOTC_METRIC_ERROR, IOTC_METRIC_STRING, IOTC_METRIC_INTEGER, IOTC_METRIC_FLOAT,
IOTC_METRIC_BOOLEAN, IOTC_METRIC_UNKNOWN }
Denotes the metric unit type.
enum IotcMetricResponseStatus
{ IOTC_METRIC_SUCCESS, IOTC_METRIC_STORED, IOTC_METRIC_NOT_ALLOWED, IOTC_METRIC_FAILED }
Status of the metric response sent from the Agent SDK.
  • IOTC_METRIC_FAILED: Metric failed to be stored at the agent or sent to the server.
  • IOTC_METRIC_NOT_ALLOWED: The metric is not in the allowed list.
  • IOTC_METRIC_STORED: The metric is successfully stored in the agent.
  • IOTC_METRIC_SUCCESS: The metric is successfully sent to the server.
IotcClientLogLevel
{
IOTC_LOG_EMERG = 0, IOTC_LOG_ALERT = 1, IOTC_LOG_CRIT = 2, IOTC_LOG_ERROR = 3,
IOTC_LOG_WARN = 4, IOTC_LOG_NOTICE = 5, IOTC_LOG_INFO = 6, IOTC_LOG_DEBUG = 7 }
Denotes the SDK client log levels.