CkJsonObject Ruby Reference Documentation

CkJsonObject

Represents a JSON object, which contains an unordered set of name/value pairs. Each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

obj = Chilkat::CkJsonObject.new()

Properties

# strVal is a string
# ckStr is a CkString
jsonObject.get_DebugLogFilePath(ckStr);
strVal = jsonObject.debugLogFilePath();
jsonObject.put_DebugLogFilePath(strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

# strVal is a string
# ckStr is a CkString
jsonObject.get_DelimiterChar(ckStr);
strVal = jsonObject.delimiterChar();
jsonObject.put_DelimiterChar(strVal);

Introduced in version 9.5.0.58

Sets the delimiter char for JSON paths. The default value is ".". To use Firebase style paths, set this property to "/". (This is a string property that should have a length of 1 char.)

# boolVal is a boolean
boolVal = jsonObject.get_EmitCompact();
jsonObject.put_EmitCompact(boolVal);

Introduced in version 9.5.0.56

If true then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If false, then emits with whitespace and indentation to make the JSON human-readable.

The default value is true.

# boolVal is a boolean
boolVal = jsonObject.get_EmitCrLf();
jsonObject.put_EmitCrLf(boolVal);

Introduced in version 9.5.0.56

If true then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If false, then bare-LF's are emitted. (The compact format emits to a single line with no end-of-line characters.) Windows systems traditionally use CRLF line-endings, whereas Linux, Mac OS X, and other systems traditionally use bare-LF line-endings.

The default value is true.

# intVal is an integer
intVal = jsonObject.get_I();
jsonObject.put_I(intVal);

Introduced in version 9.5.0.56

The value of the "i" index to be used when evaluating a JSON path.

JSON Paths

# intVal is an integer
intVal = jsonObject.get_J();
jsonObject.put_J(intVal);

Introduced in version 9.5.0.56

The value of the "j" index to be used when evaluating a JSON path.

# intVal is an integer
intVal = jsonObject.get_K();
jsonObject.put_K(intVal);

Introduced in version 9.5.0.56

The value of the "k" index to be used when evaluating a JSON path.

# strVal is a string
# ckStr is a CkString
jsonObject.get_LastErrorHtml(ckStr);
strVal = jsonObject.lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# strVal is a string
# ckStr is a CkString
jsonObject.get_LastErrorText(ckStr);
strVal = jsonObject.lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
jsonObject.get_LastErrorXml(ckStr);
strVal = jsonObject.lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# boolVal is a boolean
boolVal = jsonObject.get_LastMethodSuccess();
jsonObject.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# intVal is an integer
intVal = jsonObject.get_Size();

Introduced in version 9.5.0.56

The number of name/value members in this JSON object.

JSON Iterate Members

# boolVal is a boolean
boolVal = jsonObject.get_Utf8();
jsonObject.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

# boolVal is a boolean
boolVal = jsonObject.get_VerboseLogging();
jsonObject.put_VerboseLogging(boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

# strVal is a string
# ckStr is a CkString
jsonObject.get_Version(ckStr);
strVal = jsonObject.version();

Version of the component/library, such as "9.5.0.63"

Methods

# index is an integer
# name is a string
status = jsonObject.AddArrayAt(index, name);

Introduced in version 9.5.0.56

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Create more Complex JSON Document

# index is an integer
# name is a string
# value is a boolean
status = jsonObject.AddBoolAt(index, name, value);

Introduced in version 9.5.0.56

Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON: Miscellaneous Operations

# index is an integer
# name is a string
# value is an integer
status = jsonObject.AddIntAt(index, name, value);

Introduced in version 9.5.0.56

Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Create JSON Document

# index is an integer
# name is a string
status = jsonObject.AddNullAt(index, name);

Introduced in version 9.5.0.56

Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON: Miscellaneous Operations

# index is an integer
# name is a string
# numericStr is a string
status = jsonObject.AddNumberAt(index, name, numericStr);

Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Create more Complex JSON Document

# index is an integer
# name is a string
status = jsonObject.AddObjectAt(index, name);

Introduced in version 9.5.0.56

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Create more Complex JSON Document

# index is an integer
# name is a string
# value is a string
status = jsonObject.AddStringAt(index, name, value);

Introduced in version 9.5.0.56

Inserts a new string member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Create JSON Document

# returns a CkJsonArray
# name is a string
ret_jsonArray = jsonObject.AppendArray(name);

Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Returns nil on failure

# name is a string
# value is a boolean
status = jsonObject.AppendBool(name, value);

Introduced in version 9.5.0.58

Appends a new boolean member. (This is the same as passing -1 to the AddBoolAt method.)

Returns true for success, false for failure.

# name is a string
# value is an integer
status = jsonObject.AppendInt(name, value);

Introduced in version 9.5.0.58

Appends a new integer member. (This is the same as passing an index of -1 to the AddIntAt method.)

Returns true for success, false for failure.

# returns a CkJsonObject
# name is a string
ret_jsonObject = jsonObject.AppendObject(name);

Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Returns nil on failure

# name is a string
# value is a string
status = jsonObject.AppendString(name, value);

Introduced in version 9.5.0.58

Appends a new string member. (This is the same as passing -1 to the AddStringAt method.)

Returns true for success, false for failure.

# name is a string
# values is a CkStringTable
status = jsonObject.AppendStringArray(name, values);

Introduced in version 9.5.0.67

Appends an array of string values.

Returns true for success, false for failure.

JSON Append String Array

# returns a CkJsonArray
# index is an integer
ret_jsonArray = jsonObject.ArrayAt(index);

Introduced in version 9.5.0.56

Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns nil on failure

Create more Complex JSON Document

# returns a CkJsonArray
# jsonPath is a string
ret_jsonArray = jsonObject.ArrayOf(jsonPath);

Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns nil on failure

JSON: Access Array Values

Modify Parts of JSON Document

JSON Paths

# index is an integer
retBool = jsonObject.BoolAt(index);

Introduced in version 9.5.0.56

Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

JSON: Miscellaneous Operations

# jsonPath is a string
retBool = jsonObject.BoolOf(jsonPath);

Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

JSON: Miscellaneous Operations

JSON Paths

# jsonPath is a string
# encoding is a string
# bd is a CkBinData
status = jsonObject.BytesOf(jsonPath, encoding, bd);

Introduced in version 9.5.0.68

Appends the binary bytes at the specified jsonPath to bd. The encoding indicates the encoding of the bytes, such as "base64", "hex", etc.

Returns true for success, false for failure.

# returns a CkJsonObject
ret_jsonObject = jsonObject.Clone();

Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns nil on failure

# name is a string
status = jsonObject.Delete(name);

Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns true for success, false for failure.

JSON: Renaming and Deleting Members

# index is an integer
status = jsonObject.DeleteAt(index);

Introduced in version 9.5.0.56

Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON: Renaming and Deleting Members

# outStr is a CkString (output)
status = jsonObject.Emit(outStr);
retStr = jsonObject.emit();

Introduced in version 9.5.0.56

Writes the JSON document (rooted at the caller) and returns as a string.

Returns true for success, false for failure.

Pretty Print JSON (Formatter, Beautifier)

# sb is a CkStringBuilder
status = jsonObject.EmitSb(sb);

Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns true for success, false for failure.

# subs is a CkHashtable
# omitEmpty is a boolean
# outStr is a CkString (output)
status = jsonObject.EmitWithSubs(subs, omitEmpty, outStr);
retStr = jsonObject.emitWithSubs(subs, omitEmpty);

Introduced in version 9.5.0.67

Emits the JSON document with variable substitutions applied. If omitEmpty is true, then members having empty strings or empty arrays are omitted.

Returns true for success, false for failure.

Using Pre-defined JSON Templates

# returns a CkJsonObject
# name is a string
ret_jsonObject = jsonObject.FindObjectWithMember(name);

Introduced in version 9.5.0.67

Recursively searches the JSON subtree rooted at the caller's node for a JSON object containing a member having a specified name. (If the caller is the root node of the entire JSON document, then the entire JSON document is searched.) Returns the first match or nil if not found.

Returns nil on failure

# returns a CkJsonObject
# arrayPath is a string
# relPath is a string
# value is a string
# caseSensitive is a boolean
ret_jsonObject = jsonObject.FindRecord(arrayPath, relPath, value, caseSensitive);

Introduced in version 9.5.0.63

Finds a JSON record in an array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns nil on failure

JSON FindRecord Example

# arrayPath is a string
# relPath is a string
# value is a string
# caseSensitive is a boolean
# retRelPath is a string
# outStr is a CkString (output)
status = jsonObject.FindRecordString(arrayPath, relPath, value, caseSensitive, retRelPath, outStr);
retStr = jsonObject.findRecordString(arrayPath, relPath, value, caseSensitive, retRelPath);

Introduced in version 9.5.0.63

Finds a JSON value in an record array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns true for success, false for failure.

JSON FindRecordString Example

# name is a string
# data is a string
status = jsonObject.FirebaseApplyEvent(name, data);

Introduced in version 9.5.0.58

Applies a Firebase event to the JSON. The data contains JSON having a format such as

{"path": "/", "data": {"a": 1, "b": 2}}
The name should be "put" or "patch".

Returns true for success, false for failure.

Firebase Receive Server-Sent Events (text/event-stream)

# jsonPath is a string
# jsonData is a string
status = jsonObject.FirebasePatch(jsonPath, jsonData);

Introduced in version 9.5.0.58

For each key in the jsonData, update (or add) the corresponding key in the JSON at the given jsonPath. The jsonPath is relative to this JSON object. (This is effectively applying a Firebase patch event.)

Returns true for success, false for failure.

Firebase JSON Put and Patch

# jsonPath is a string
# value is a string
status = jsonObject.FirebasePut(jsonPath, value);

Introduced in version 9.5.0.58

Inserts or replaces the value at the jsonPath. The value can contain JSON text, an integer (in decimal string format), a boolean (true/false), the keyword "null", or a quoted string.

The jsonPath is relative to this JSON object. (This is effectively applying a Firebase put event.)

Returns true for success, false for failure.

Firebase JSON Put and Patch

# returns a CkJsonObject
ret_jsonObject = jsonObject.GetDocRoot();

Introduced in version 9.5.0.56

Returns the root of the JSON document. The root can be obtained from any JSON object within the JSON document. The entire JSON document remains in memory as long as at least one JSON object is referenced by the application. When the last reference is removed, the entire JSON document is automatically dellocated.

Returns nil on failure

Get the Root of a JSON Document

# jsonPath is a string
status = jsonObject.HasMember(jsonPath);

Introduced in version 9.5.0.58

Returns true if the item at the jsonPath exists.

Returns true for success, false for failure.

# name is a string
retInt = jsonObject.IndexOf(name);

Introduced in version 9.5.0.56

Returns the index of the member having the given name. Returns -1 if the name is not found.

Get the Index of a JSON Member

# index is an integer
retInt = jsonObject.IntAt(index);

Introduced in version 9.5.0.56

Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

JSON Iterate Members

# jsonPath is a string
retInt = jsonObject.IntOf(jsonPath);

Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

JSON: Miscellaneous Operations

JSON Paths

# index is an integer
retBool = jsonObject.IsNullAt(index);

Introduced in version 9.5.0.56

Returns the boolean value of the member having the specified index.

JSON: Miscellaneous Operations

# jsonPath is a string
retBool = jsonObject.IsNullOf(jsonPath);

Introduced in version 9.5.0.56

Returns true if the value at the specified jsonPath is null. Otherwise returns false.

JSON: Miscellaneous Operations

JSON Paths

# json is a string
status = jsonObject.Load(json);

Introduced in version 9.5.0.56

Parses a JSON string and loads it into this JSON object to provide DOM-style access.

Returns true for success, false for failure.

Load JSON Data at Path

Load a JSON Array

Loading and Parsing a JSON Array

# path is a string
status = jsonObject.LoadFile(path);

Introduced in version 9.5.0.56

Loads a JSON file into this JSON object. The path is the file path to the JSON file.

Returns true for success, false for failure.

Load a JSON Array

# name is a string
status = jsonObject.LoadPredefined(name);

Introduced in version 9.5.0.67

Loads this JSON object from a predefined document having a specified name.

Returns true for success, false for failure.

Using Pre-defined JSON Templates

# sb is a CkStringBuilder
status = jsonObject.LoadSb(sb);

Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns true for success, false for failure.

# index is an integer
# outStr is a CkString (output)
status = jsonObject.NameAt(index, outStr);
retStr = jsonObject.nameAt(index);

Introduced in version 9.5.0.56

Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON Iterate Members

# returns a CkJsonObject
# index is an integer
ret_jsonObject = jsonObject.ObjectAt(index);

Introduced in version 9.5.0.56

Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns nil on failure

Create more Complex JSON Document

# returns a CkJsonObject
# jsonPath is a string
ret_jsonObject = jsonObject.ObjectOf(jsonPath);

Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns nil on failure

JSON: Nested Objects

JSON Paths

# name is a string
status = jsonObject.Predefine(name);

Introduced in version 9.5.0.67

Adds or replaces this JSON to an internal global set of predefined JSON documents that can be subsequently loaded by name.

Returns true for success, false for failure.

Using Pre-defined JSON Templates

# oldName is a string
# newName is a string
status = jsonObject.Rename(oldName, newName);

Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns true for success, false for failure.

JSON: Renaming and Deleting Members

# index is an integer
# name is a string
status = jsonObject.RenameAt(index, name);

Introduced in version 9.5.0.56

Renames the member at index to name.

Returns true for success, false for failure.

JSON: Renaming and Deleting Members

# path is a string
status = jsonObject.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

# index is an integer
# value is a boolean
status = jsonObject.SetBoolAt(index, value);

Introduced in version 9.5.0.56

Sets the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Modify Parts of JSON Document

# jsonPath is a string
# value is a boolean
status = jsonObject.SetBoolOf(jsonPath, value);

Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns true for success, false for failure.

Modify Parts of JSON Document

JSON Paths

# index is an integer
# value is an integer
status = jsonObject.SetIntAt(index, value);

Introduced in version 9.5.0.56

Sets the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Modify Parts of JSON Document

# jsonPath is a string
# value is an integer
status = jsonObject.SetIntOf(jsonPath, value);

Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns true for success, false for failure.

Modify Parts of JSON Document

JSON Paths

# index is an integer
status = jsonObject.SetNullAt(index);

Introduced in version 9.5.0.56

Sets the value of the Nth member to null. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON: Miscellaneous Operations

# jsonPath is a string
status = jsonObject.SetNullOf(jsonPath);

Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns true for success, false for failure.

JSON: Miscellaneous Operations

JSON Paths

# index is an integer
# value is a string
status = jsonObject.SetNumberAt(index, value);

Introduced in version 9.5.0.56

Sets the numeric value of the Nth member. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON: Miscellaneous Operations

# jsonPath is a string
# value is a string
status = jsonObject.SetNumberOf(jsonPath, value);

Introduced in version 9.5.0.56

Sets the numeric value at the specified jsonPath. The value is an integer, float, or double already converted to a string in the format desired by the application.

Returns true for success, false for failure.

JSON: Miscellaneous Operations

JSON Paths

# index is an integer
# value is a string
status = jsonObject.SetStringAt(index, value);

Introduced in version 9.5.0.56

Sets the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

Modify Parts of JSON Document

# jsonPath is a string
# value is a string
status = jsonObject.SetStringOf(jsonPath, value);

Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns true for success, false for failure.

Modify Parts of JSON Document

JSON Paths

# jsonPath is a string
retInt = jsonObject.SizeOfArray(jsonPath);

Introduced in version 9.5.0.56

Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.

JSON Paths

# index is an integer
# outStr is a CkString (output)
status = jsonObject.StringAt(index, outStr);
retStr = jsonObject.stringAt(index);

Introduced in version 9.5.0.56

Returns the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

JSON Iterate Members

# jsonPath is a string
# outStr is a CkString (output)
status = jsonObject.StringOf(jsonPath, outStr);
retStr = jsonObject.stringOf(jsonPath);

Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns true for success, false for failure.

JSON: Miscellaneous Operations

JSON Paths

JSON Paths that need Double Quotes

# jsonPath is a string
# sb is a CkStringBuilder
status = jsonObject.StringOfSb(jsonPath, sb);

Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns true for success, false for failure.

# index is an integer
retInt = jsonObject.TypeAt(index);

Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

  1. string
  2. number
  3. object
  4. array
  5. boolean
  6. null
Returns -1 if no member exists at the given index.

# jsonPath is a string
# encoding is a string
# bd is a CkBinData
status = jsonObject.UpdateBd(jsonPath, encoding, bd);

Introduced in version 9.5.0.68

Updates or appends a new string member with the encoded contents of bd. If the full path specified by jsonPath does not exist, it is automatically created as needed. The bytes contained in bd are encoded according to encoding (such as "base64", "hex", etc.)

Returns true for success, false for failure.

# jsonPath is a string
# value is a boolean
status = jsonObject.UpdateBool(jsonPath, value);

Introduced in version 9.5.0.63

Updates or appends a new boolean member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

# jsonPath is a string
# value is an integer
status = jsonObject.UpdateInt(jsonPath, value);

Introduced in version 9.5.0.63

Updates or appends a new integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

# jsonPath is a string
status = jsonObject.UpdateNull(jsonPath);

Introduced in version 9.5.0.65

Updates or appends a null member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

# jsonPath is a string
# numericStr is a string
status = jsonObject.UpdateNumber(jsonPath, numericStr);

Introduced in version 9.5.0.65

Updates or appends a new numeric member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

# jsonPath is a string
# sb is a CkStringBuilder
status = jsonObject.UpdateSb(jsonPath, sb);

Introduced in version 9.5.0.68

Updates or appends a new string member with the contents of sb. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

# jsonPath is a string
# value is a string
status = jsonObject.UpdateString(jsonPath, value);

Introduced in version 9.5.0.63

Updates or appends a new string member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Important: Prior to version 9.5.0.68, the string passed in to this method did not get properly JSON escaped. This could cause problems if non-us-ascii chars are present, or if certain special chars such as quotes, CR's, or LF's are present. Version 9.5.0.68 fixes the problem.

Returns true for success, false for failure.

JSON UpdateString