From c17301bcb5ee80e1fcd339608e114f582cbf4017 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Blanchon?= Date: Thu, 5 Jan 2017 21:46:09 +0100 Subject: [PATCH] Updated API Reference (markdown) --- API-Reference.md | 151 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 110 insertions(+), 41 deletions(-) diff --git a/API-Reference.md b/API-Reference.md index 7793ed3..42321d7 100644 --- a/API-Reference.md +++ b/API-Reference.md @@ -5,51 +5,53 @@ Some parts have been simplified to be easier to understand, so if you look at th - [Configuration](#configuration) - - [ARDUINOJSON_USE_DOUBLE](#arduinojsonusedouble) - - [ARDUINOJSON_USE_LONG_LONG](#arduinojsonuselonglong) - - [ARDUINOJSON_ENABLE_ARDUINO_STRING](#arduinojsonenablearduinostring) - - [ARDUINOJSON_ENABLE_STD_STRING](#arduinojsonenablestdstring) - - [ARDUINOJSON_DEFAULT_NESTING_LIMIT](#arduinojsondefaultnestinglimit) + - [ARDUINOJSON_USE_DOUBLE](#arduinojsonusedouble) + - [ARDUINOJSON_USE_LONG_LONG](#arduinojsonuselonglong) + - [ARDUINOJSON_ENABLE_ARDUINO_STRING](#arduinojsonenablearduinostring) + - [ARDUINOJSON_ENABLE_STD_STRING](#arduinojsonenablestdstring) + - [ARDUINOJSON_DEFAULT_NESTING_LIMIT](#arduinojsondefaultnestinglimit) - [JsonArray](#jsonarray) - - [Constructor](#constructor) - - [JsonArray::add\(\)](#jsonarrayadd) - - [JsonArray::createNestedArray\(\)](#jsonarraycreatenestedarray) - - [JsonArray::createNestedObject\(\)](#jsonarraycreatenestedobject) - - [JsonArray::get\(\)](#jsonarrayget) - - [JsonArray::measureLength\(\)](#jsonarraymeasurelength) - - [JsonArray::measurePrettyLength\(\)](#jsonarraymeasureprettylength) - - [JsonArray::operator\[\]](#jsonarrayoperator) - - [JsonArray::prettyPrintTo\(\)](#jsonarrayprettyprintto) - - [JsonArray::printTo\(\)](#jsonarrayprintto) - - [JsonArray::removeAt\(\)](#jsonarrayremoveat) - - [JsonArray::set\(\)](#jsonarrayset) - - [JsonArray::size\(\)](#jsonarraysize) - - [JsonArray::success\(\)](#jsonarraysuccess) + - [Constructor](#constructor) + - [JsonArray::add\(\)](#jsonarrayadd) + - [JsonArray::copyFrom\(\)](#jsonarraycopyfrom) + - [JsonArray::copyTo\(\)](#jsonarraycopyto) + - [JsonArray::createNestedArray\(\)](#jsonarraycreatenestedarray) + - [JsonArray::createNestedObject\(\)](#jsonarraycreatenestedobject) + - [JsonArray::get\(\)](#jsonarrayget) + - [JsonArray::measureLength\(\)](#jsonarraymeasurelength) + - [JsonArray::measurePrettyLength\(\)](#jsonarraymeasureprettylength) + - [JsonArray::operator\[\]](#jsonarrayoperator) + - [JsonArray::prettyPrintTo\(\)](#jsonarrayprettyprintto) + - [JsonArray::printTo\(\)](#jsonarrayprintto) + - [JsonArray::removeAt\(\)](#jsonarrayremoveat) + - [JsonArray::set\(\)](#jsonarrayset) + - [JsonArray::size\(\)](#jsonarraysize) + - [JsonArray::success\(\)](#jsonarraysuccess) - [JsonBuffer \(DynamicJsonBuffer and StaticJsonBuffer\)](#jsonbuffer-dynamicjsonbuffer-and-staticjsonbuffer) - - [JsonBuffer::createArray\(\)](#jsonbuffercreatearray) - - [JsonBuffer::createObject\(\)](#jsonbuffercreateobject) - - [JsonBuffer::parseArray\(\)](#jsonbufferparsearray) - - [JsonBuffer::parseObject\(\)](#jsonbufferparseobject) - - [JsonBuffer::strdup\(\)](#jsonbufferstrdup) + - [JsonBuffer::createArray\(\)](#jsonbuffercreatearray) + - [JsonBuffer::createObject\(\)](#jsonbuffercreateobject) + - [JsonBuffer::parseArray\(\)](#jsonbufferparsearray) + - [JsonBuffer::parseObject\(\)](#jsonbufferparseobject) + - [JsonBuffer::strdup\(\)](#jsonbufferstrdup) - [JsonObject](#jsonobject) - - [Constructor](#constructor-1) - - [JsonObject::begin\(\) / JsonObject::end\(\)](#jsonobjectbegin--jsonobjectend) - - [JsonObject::createNestedArray\(\)](#jsonobjectcreatenestedarray) - - [JsonObject::createNestedObject\(\)](#jsonobjectcreatenestedobject) - - [JsonObject::containsKey\(\)](#jsonobjectcontainskey) - - [JsonObject::get\(\)](#jsonobjectget) - - [JsonObject::measureLength\(\)](#jsonobjectmeasurelength) - - [JsonObject::measurePrettyLength\(\)](#jsonobjectmeasureprettylength) - - [JsonObject::operator\[\]](#jsonobjectoperator) - - [JsonObject::prettyPrintTo\(\)](#jsonobjectprettyprintto) - - [JsonObject::printTo\(\)](#jsonobjectprintto) - - [JsonObject::remove\(\)](#jsonobjectremove) - - [JsonObject::set\(\)](#jsonobjectset) - - [JsonObject::size\(\)](#jsonobjectsize) - - [JsonObject::success\(\)](#jsonobjectsuccess) + - [Constructor](#constructor-1) + - [JsonObject::begin\(\) / JsonObject::end\(\)](#jsonobjectbegin--jsonobjectend) + - [JsonObject::createNestedArray\(\)](#jsonobjectcreatenestedarray) + - [JsonObject::createNestedObject\(\)](#jsonobjectcreatenestedobject) + - [JsonObject::containsKey\(\)](#jsonobjectcontainskey) + - [JsonObject::get\(\)](#jsonobjectget) + - [JsonObject::measureLength\(\)](#jsonobjectmeasurelength) + - [JsonObject::measurePrettyLength\(\)](#jsonobjectmeasureprettylength) + - [JsonObject::operator\[\]](#jsonobjectoperator) + - [JsonObject::prettyPrintTo\(\)](#jsonobjectprettyprintto) + - [JsonObject::printTo\(\)](#jsonobjectprintto) + - [JsonObject::remove\(\)](#jsonobjectremove) + - [JsonObject::set\(\)](#jsonobjectset) + - [JsonObject::size\(\)](#jsonobjectsize) + - [JsonObject::success\(\)](#jsonobjectsuccess) - [JsonVariant](#jsonvariant) - - [JsonVariant::as\(\)](#jsonvariantas) - - [JsonVariant::is\(\)](#jsonvariantis) + - [JsonVariant::as\(\)](#jsonvariantas) + - [JsonVariant::is\(\)](#jsonvariantis) @@ -182,6 +184,73 @@ will write ["hello",3.1416] ``` +### JsonArray::copyFrom() + +##### Description + +Populates the `JsonArray` with values from a C array. + +##### Signatures + +```c++ +JsonArray::copyFrom(int array[]); +JsonArray::copyFrom(double array[]); +JsonArray::copyFrom(const char* array[]); +``` + +##### Return value + +`true` if the operation is successful; or `false` if there was not enough room in the `JsonBuffer`. + +##### Example + +```c++ +int values[] = {1, 2, 3}; + +StaticJsonBuffer<200> jsonBuffer; +JsonArray& array = jsonBuffer.createArray(); +array.copyFrom(values); +array.printTo(Serial); +``` + +will write + +```json +[1,2,3] +``` + + +### JsonArray::copyTo() + +##### Description + +Extracts a C array from the `JsonArray`. + +##### Signatures + +```c++ +JsonArray::copyTo(int array[]); +JsonArray::copyTo(double array[]); +JsonArray::copyTo(const char* array[]); +``` + +##### Return value + +A `size_t` containing the number of values written in the array. + +##### Example + +```c++ +int values[3]; + +StaticJsonBuffer<200> jsonBuffer; +JsonArray& array = jsonBuffer.parseArray("[1,2,3]"); +array.copyTo(values); +``` + +now `values` contais `1`, `2` and `3`. + + ### JsonArray::createNestedArray()