CkJsonObject CkPython Reference Documentation
CkJsonObject
Current Version: 10.0.0
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()
Properties
DebugLogFilePath
# 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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
DelimiterChar
# ckStr is a CkString
jsonObject.get_DelimiterChar(ckStr);
strVal = jsonObject.delimiterChar();
jsonObject.put_DelimiterChar(strVal);
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.)
topEmitCompact
boolVal = jsonObject.get_EmitCompact();
jsonObject.put_EmitCompact(boolVal);
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.
topEmitCrLf
boolVal = jsonObject.get_EmitCrLf();
jsonObject.put_EmitCrLf(boolVal);
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.
topI
intVal = jsonObject.get_I();
jsonObject.put_I(intVal);
The value of the "i" index to be used when evaluating a JSON path.
J
intVal = jsonObject.get_J();
jsonObject.put_J(intVal);
The value of the "j" index to be used when evaluating a JSON path.
topK
intVal = jsonObject.get_K();
jsonObject.put_K(intVal);
The value of the "k" index to be used when evaluating a JSON path.
topLastErrorHtml
# 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.
topLastErrorText
# 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.
LastErrorXml
# 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.
topLastMethodSuccess
boolVal = jsonObject.get_LastMethodSuccess();
jsonObject.put_LastMethodSuccess(boolVal);
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.
topLowerCaseNames
boolVal = jsonObject.get_LowerCaseNames();
jsonObject.put_LowerCaseNames(boolVal);
If True then all member names are converted to lowercase when the JSON is initially loaded by the following methods: Load, LoadBd, LoadSb, LoadFile.
The default value is False.
topPathPrefix
# ckStr is a CkString
jsonObject.get_PathPrefix(ckStr);
strVal = jsonObject.pathPrefix();
jsonObject.put_PathPrefix(strVal);
A prefix string that is automatically added to the JSON path passed in the first argument for other methods (such as StringOf, UpdateString, SetBoolOf, SizeOfArray, etc.)
The default value is the empty string.
topSize
intVal = jsonObject.get_Size();
UncommonOptions
# ckStr is a CkString
jsonObject.get_UncommonOptions(ckStr);
strVal = jsonObject.uncommonOptions();
jsonObject.put_UncommonOptions(strVal);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topUtf8
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.
topVerboseLogging
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.
topVersion
# ckStr is a CkString
jsonObject.get_Version(ckStr);
strVal = jsonObject.version();
Methods
AddArrayAt
# name is a string
status = jsonObject.AddArrayAt(index, name);
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.
AddArrayCopyAt
# name is a string
# jarr is a CkJsonArray
status = jsonObject.AddArrayCopyAt(index, name, jarr);
Inserts a copy of a JSON array 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.
AddBoolAt
# name is a string
# value is a boolean
status = jsonObject.AddBoolAt(index, name, value);
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.
AddIntAt
# name is a string
# value is an integer
status = jsonObject.AddIntAt(index, name, value);
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.
AddNullAt
# name is a string
status = jsonObject.AddNullAt(index, name);
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.
AddNumberAt
# name is a string
# numericStr is a string
status = jsonObject.AddNumberAt(index, name, numericStr);
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.
AddObjectAt
# name is a string
status = jsonObject.AddObjectAt(index, name);
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.
AddObjectCopyAt
# name is a string
# jsonObj is a CkJsonObject
status = jsonObject.AddObjectCopyAt(index, name, jsonObj);
Inserts a copy of a JSON object 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.
AddStringAt
# name is a string
# value is a string
status = jsonObject.AddStringAt(index, name, value);
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.
AppendArray
Appends a new and empty JSON array and returns it.
Important: The name is the member name, it is not a JSON path.
Returns None on failure
AppendArrayCopy
Appends a copy of a JSON array.
Important: The name is the member name, it is not a JSON path.
Returns True for success, False for failure.
AppendBool
# value is a boolean
status = jsonObject.AppendBool(name, value);
Appends a new boolean member. (This is the same as passing -1 to the AddBoolAt method.)
Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateBool instead.
Returns True for success, False for failure.
topAppendInt
# value is an integer
status = jsonObject.AppendInt(name, value);
Appends a new integer member. (This is the same as passing an index of -1 to the AddIntAt method.)
Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateInt instead.
Returns True for success, False for failure.
topAppendObject
# name is a string
ret_jsonObject = jsonObject.AppendObject(name);
Appends a new and empty JSON object and returns it.
Important: The name is the member name, it is not a JSON path.
Returns None on failure
AppendObjectCopy
# jsonObj is a CkJsonObject
status = jsonObject.AppendObjectCopy(name, jsonObj);
Appends a copy of a JSON object.
Important: The name is the member name, it is not a JSON path.
Returns True for success, False for failure.
AppendString
# value is a string
status = jsonObject.AppendString(name, value);
Appends a new string member. (This is the same as passing -1 to the AddStringAt method.)
Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateString instead.
Returns True for success, False for failure.
topAppendStringArray
Appends an array of string values.
Important: The name is the member name, it is not a JSON path.
Returns True for success, False for failure.
ArrayAt
Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns None on failure
ArrayOf
Returns the JSON array at the specified jsonPath.
Returns None on failure
BoolAt
retBool = jsonObject.BoolAt(index);
Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
BoolOf
retBool = jsonObject.BoolOf(jsonPath);
BytesOf
# encoding is a string
# bd is a CkBinData
status = jsonObject.BytesOf(jsonPath, encoding, bd);
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.
Clear
Clears the contents of the JSON object. This is the equivalent of calling jsonObject.Load("{}")
topClone
ret_jsonObject = jsonObject.Clone();
DateOf
Fills the dateTime with the date/time string located at jsonPath. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.
Returns True for success, False for failure.
Delete
status = jsonObject.Delete(name);
Deletes the member at having the name specified by name. Note: The name is not a tag path. It is the name of a member of this JSON object.
Returns True for success, False for failure.
DeleteAt
status = jsonObject.DeleteAt(index);
Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
DeleteRecords
# relpath is a string
# value is a string
# caseSensitive is a boolean
retInt = jsonObject.DeleteRecords(arrayPath, relpath, value, caseSensitive);
Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.
topDtOf
# bLocal is a boolean
# dt is a CkDtObj
status = jsonObject.DtOf(jsonPath, bLocal, dt);
Fills the dt with the date/time string located at jsonPath. If bLocal is True, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.
Returns True for success, False for failure.
Emit
Writes the JSON document (rooted at the caller) and returns as a string.
Returns True for success, False for failure.
EmitBd
EmitSb
EmitWithSubs
# omitEmpty is a boolean
# outStr is a CkString (output)
status = jsonObject.EmitWithSubs(subs, omitEmpty, outStr);
retStr = jsonObject.emitWithSubs(subs, omitEmpty);
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.
FindObjectWithMember
# name is a string
ret_jsonObject = jsonObject.FindObjectWithMember(name);
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 None if not found.
Returns None on failure
topFindRecord
# arrayPath is a string
# relPath is a string
# value is a string
# caseSensitive is a boolean
ret_jsonObject = jsonObject.FindRecord(arrayPath, relPath, value, caseSensitive);
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 None on failure
FindRecordString
# 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);
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.
FirebaseApplyEvent
# data is a string
status = jsonObject.FirebaseApplyEvent(name, data);
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.
FirebasePatch
# jsonData is a string
status = jsonObject.FirebasePatch(jsonPath, jsonData);
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.
FirebasePut
# value is a string
status = jsonObject.FirebasePut(jsonPath, value);
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.
GetDocRoot
ret_jsonObject = jsonObject.GetDocRoot();
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 None on failure
HasMember
status = jsonObject.HasMember(jsonPath);
IndexOf
retInt = jsonObject.IndexOf(name);
Returns the index of the member having the given name. Returns -1 if the name is not found.
IntAt
retInt = jsonObject.IntAt(index);
Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
IntOf
retInt = jsonObject.IntOf(jsonPath);
IsNullAt
retBool = jsonObject.IsNullAt(index);
Returns the boolean value of the member having the specified index.
IsNullOf
retBool = jsonObject.IsNullOf(jsonPath);
Returns True if the value at the specified jsonPath is null. Otherwise returns False.
JsonTypeOf
retInt = jsonObject.JsonTypeOf(jsonPath);
Returns the type of data at the given jsonPath. Possible return values are:
- 1 - string
- 2- number
- 3- object
- 4- array
- 5- boolean
- 6- null
Load
status = jsonObject.Load(json);
Parses a JSON string and loads it into this JSON object to provide DOM-style access.
Returns True for success, False for failure.
LoadBd
LoadFile
status = jsonObject.LoadFile(path);
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.
LoadPredefined
status = jsonObject.LoadPredefined(name);
Loads this JSON object from a predefined document having a specified name.
Returns True for success, False for failure.
LoadSb
Loads JSON from the contents of a StringBuilder object.
Returns True for success, False for failure.
MoveMember
# toIndex is an integer
status = jsonObject.MoveMember(fromIndex, toIndex);
Move the member from fromIndex to toIndex. If toIndex equals -1, then moves the member at position fromIndex to the last position. Set toIndex = 0 to move a member to the first position.
Returns True for success, False for failure.
topNameAt
# outStr is a CkString (output)
status = jsonObject.NameAt(index, outStr);
retStr = jsonObject.nameAt(index);
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.
ObjectAt
# index is an integer
ret_jsonObject = jsonObject.ObjectAt(index);
Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns None on failure
ObjectOf
# jsonPath is a string
ret_jsonObject = jsonObject.ObjectOf(jsonPath);
Returns the JSON object at the specified jsonPath.
Returns None on failure
Predefine
status = jsonObject.Predefine(name);
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.
Rename
# newName is a string
status = jsonObject.Rename(oldName, newName);
Renames the member named oldName to newName.
Returns True for success, False for failure.
RenameAt
# name is a string
status = jsonObject.RenameAt(index, name);
Renames the member at index to name.
Returns True for success, False for failure.
SetBoolAt
# value is a boolean
status = jsonObject.SetBoolAt(index, value);
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.
SetBoolOf
# value is a boolean
status = jsonObject.SetBoolOf(jsonPath, value);
Sets the boolean value at the specified jsonPath.
Returns True for success, False for failure.
SetIntAt
# value is an integer
status = jsonObject.SetIntAt(index, value);
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.
SetIntOf
# value is an integer
status = jsonObject.SetIntOf(jsonPath, value);
Sets the integer at the specified jsonPath.
Returns True for success, False for failure.
SetNullAt
status = jsonObject.SetNullAt(index);
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.
SetNullOf
status = jsonObject.SetNullOf(jsonPath);
Sets the value at the specified jsonPath to null.
Returns True for success, False for failure.
SetNumberAt
# value is a string
status = jsonObject.SetNumberAt(index, value);
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.
SetNumberOf
# value is a string
status = jsonObject.SetNumberOf(jsonPath, value);
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.
SetStringAt
# value is a string
status = jsonObject.SetStringAt(index, value);
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.
SetStringOf
# value is a string
status = jsonObject.SetStringOf(jsonPath, value);
Sets the string value at the specified jsonPath.
Returns True for success, False for failure.
SizeOfArray
retInt = jsonObject.SizeOfArray(jsonPath);
Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.
Sort
# caseSensitive is a boolean
jsonObject.Sort(ascending, caseSensitive);
StringAt
# outStr is a CkString (output)
status = jsonObject.StringAt(index, outStr);
retStr = jsonObject.stringAt(index);
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.
StringOf
# outStr is a CkString (output)
status = jsonObject.StringOf(jsonPath, outStr);
retStr = jsonObject.stringOf(jsonPath);
Returns the string value at the specified jsonPath.
Returns True for success, False for failure.
StringOfEquals
# value is a string
# caseSensitive is a boolean
retBool = jsonObject.StringOfEquals(jsonPath, value, caseSensitive);
Returns True if the string value at the specified jsonPath equals value. Otherwise returns False
topStringOfSb
Appends the string value at the specified jsonPath to sb.
Returns True for success, False for failure.
topSwap
# index2 is an integer
status = jsonObject.Swap(index1, index2);
Swaps the positions of members at index1 and index2.
Returns True for success, False for failure.
TypeAt
retInt = jsonObject.TypeAt(index);
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntOf
retInt = jsonObject.UIntOf(jsonPath);
Returns the unsigned integer at the specified jsonPath.
topUpdateBd
# encoding is a string
# bd is a CkBinData
status = jsonObject.UpdateBd(jsonPath, encoding, bd);
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.
UpdateBool
# value is a boolean
status = jsonObject.UpdateBool(jsonPath, value);
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.
topUpdateInt
# value is an integer
status = jsonObject.UpdateInt(jsonPath, value);
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.
UpdateNewArray
status = jsonObject.UpdateNewArray(jsonPath);
Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.
Returns True for success, False for failure.
UpdateNewObject
status = jsonObject.UpdateNewObject(jsonPath);
Updates or appends a new and empty JSON object at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.
Returns True for success, False for failure.
UpdateNull
status = jsonObject.UpdateNull(jsonPath);
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.
topUpdateNumber
# numericStr is a string
status = jsonObject.UpdateNumber(jsonPath, numericStr);
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.
UpdateSb
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.
topUpdateString
# value is a string
status = jsonObject.UpdateString(jsonPath, value);
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.
UpdateUInt
# value is an integer
status = jsonObject.UpdateUInt(jsonPath, value);
Updates or appends a new unsigned 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.
topWriteFile
status = jsonObject.WriteFile(path);