JSON document parameter to store the details of keys and where to store them. More...
#include <ota_private.h>
Data Fields | |
const char * | pSrcKey |
const bool | required |
uint16_t | pDestOffset |
uint16_t | pDestSizeOffset |
const ModelParamType_t | modelParamType |
JSON document parameter to store the details of keys and where to store them.
This is a document parameter structure used by the document model. It determines the type of parameter specified by the key name and where to store the parameter locally when it is extracted from the JSON document. It also contains the expected Jasmine type of the value field for validation.
const char* JsonDocParam_t::pSrcKey |
Expected key name.
const bool JsonDocParam_t::required |
If true, this parameter must exist in the document.
uint16_t JsonDocParam_t::pDestOffset |
Offset to where we will store the value, if not ~0.
uint16_t JsonDocParam_t::pDestSizeOffset |
Offset to where we will store the value, if not ~0.
const ModelParamType_t JsonDocParam_t::modelParamType |
We extract the value, if found, based on this type.