JsonBuilder Class Methods
In this section, the JsonBuilder class methods are presented in alphabetical order.
Syntax
AddElement(Element)
Description
Use this method to add an element.
Parameters
|
Field or Control |
Definition |
|---|---|
| Element |
Specifies the element that needs to be added as any type. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
If &jBldr.StartArrayReturnsTrue("properties") Then
&jBldr.AddElement("content");
&jBldr.EndArray("properties");
End-If;Syntax
AddNullElement()
Description
Use this method to add a null element at the end of an array.
Parameters
None.
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
If &jBldr.StartArrayReturnsTrue("properties") Then
&jBldr.AddNullElement();
&jBldr.EndArray("properties");
End-If;Syntax
AddNullProperty(Name)
Description
Use this method to add the property with null as its value.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the property as a string. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
&jBldr.AddNullProperty("Item_None");Syntax
AddProperty(Name, Type)
Description
Use this method to add a property.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the property as a string. |
| Type |
Specifies the type of the property as any. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
&jBldr.AddProperty("store", "false");
&jbldr.AddProperty("description", "orcl_attachment_pipe");
&jbldr.AddProperty("ignore_above", "254");
&jbldr.AddProperty("tokenizer", "whitespace");Syntax
EndArray(Name)
Description
Use this method to end the Json array with a name that is optional.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the Json array as a string. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
&jBldr.EndArray("filter");Syntax
EndObject(Name)
Description
Use this method to end the Json object with a name that is optional.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the Json object as a string. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
&jBldr.EndObject("filter");Syntax
GetBuildMode()
Description
Use this method to get the build mode such as array, object, and so on.
Parameters
None.
Returns
Integer.
List of numeric values and their corresponding build modes.
|
Numeric Value |
Build Modes |
|---|---|
|
0 |
JSON_BUILD_MODE_NONE |
|
1 |
JSON_BUILD_MODE_OBJECT |
|
2 |
JSON_BUILD_MODE_ARRAY |
|
3 |
JSON_BUILD_MODE_MEMBER |
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
Local integer &iBldMode = &jBldr.GetBuildMode();Syntax
GetRootNode()
Description
Use this method to get the root node.
Parameters
None.
Returns
JsonNode.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
Local JsonNode &jNode = &jBldr.GetRootNode();Syntax
StartArray(Name)
Description
Use this method to start building the Json array with a name that is optional.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the Json array as a string. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
&jBldr.StartArray("");Syntax
StartArrayReturnsTrue(Name)
Description
Use this method to start building the Json array with a name that is optional.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the Json array as a string. |
Returns
Boolean.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
Local Boolean &bStArr = &jBldr.StartArrayReturnsTrue("articles");Syntax
StartObject(Name)
Description
Use this method to start building the Json object with a name that is optional.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the Json object as a string. |
Returns
None.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
&jBldr.StartObject("");Syntax
StartObjectReturnsTrue(Name)
Description
Use this method to start building the Json object with a name that is optional.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specifies the name of the Json object as a string. |
Returns
Boolean.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
Local Boolean &bStObj = &jBldr.StartObjectReturnsTrue("index");Syntax
ToString()
Description
Use this method to serialize the Json builder object to a string.
Parameters
None.
Returns
String.
Example
Local JsonBuilder &jBldr = CreateJsonBuilder();
Local String &jBldrStr = &jBldr.ToString();