CkoJsonObject Objective-C Reference Documentation

CkoJsonObject

Current Version: 9.5.0.75

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

CkoJsonObject *obj = [[CkoJsonObject alloc] init];

Properties

DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

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.

top
DelimiterChar
@property (nonatomic, copy) NSString *DelimiterChar;
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.)

top
EmitCompact
@property (nonatomic) BOOL EmitCompact;
Introduced in version 9.5.0.56

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

The default value is YES.

top
EmitCrLf
@property (nonatomic) BOOL EmitCrLf;
Introduced in version 9.5.0.56

If YES then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If NO, 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 YES.

top
I
@property (nonatomic, copy) NSNumber *I;
Introduced in version 9.5.0.56

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

More Information and Examples
top
J
@property (nonatomic, copy) NSNumber *J;
Introduced in version 9.5.0.56

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

top
K
@property (nonatomic, copy) NSNumber *K;
Introduced in version 9.5.0.56

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

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *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.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *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.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *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.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO 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 = YES and failure = NO.
  • 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 YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Size
@property (nonatomic, readonly, copy) NSNumber *Size;
Introduced in version 9.5.0.56

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

More Information and Examples
top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

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

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

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

top

Methods

AddArrayAt
- (BOOL)AddArrayAt:(NSNumber *)index
    name:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AddBoolAt
- (BOOL)AddBoolAt:(NSNumber *)index
    name:(NSString *)name
    value:(BOOL)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 YES for success, NO for failure.

More Information and Examples
top
AddIntAt
- (BOOL)AddIntAt:(NSNumber *)index
    name:(NSString *)name
    value:(NSNumber *)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 YES for success, NO for failure.

More Information and Examples
top
AddNullAt
- (BOOL)AddNullAt:(NSNumber *)index
    name:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AddNumberAt
- (BOOL)AddNumberAt:(NSNumber *)index
    name:(NSString *)name
    numericStr:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AddObjectAt
- (BOOL)AddObjectAt:(NSNumber *)index
    name:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AddStringAt
- (BOOL)AddStringAt:(NSNumber *)index
    name:(NSString *)name
    value:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AppendArray
- (CkoJsonArray *)AppendArray:(NSString *)name;
Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Important: The name is the member name, it is not a JSON path.

Returns nil on failure

top
AppendBool
- (BOOL)AppendBool:(NSString *)name
    value:(BOOL)value;
Introduced in version 9.5.0.58

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 YES for success, NO for failure.

top
AppendInt
- (BOOL)AppendInt:(NSString *)name
    value:(NSNumber *)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.)

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 YES for success, NO for failure.

top
AppendObject
- (CkoJsonObject *)AppendObject:(NSString *)name;
Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Important: The name is the member name, it is not a JSON path.

Returns nil on failure

top
AppendString
- (BOOL)AppendString:(NSString *)name
    value:(NSString *)value;
Introduced in version 9.5.0.58

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 YES for success, NO for failure.

top
AppendStringArray
- (BOOL)AppendStringArray:(NSString *)name
    values:(CkoStringTable *)values;
Introduced in version 9.5.0.67

Appends an array of string values.

Important: The name is the member name, it is not a JSON path.

Returns YES for success, NO for failure.

More Information and Examples
top
ArrayAt
- (CkoJsonArray *)ArrayAt:(NSNumber *)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

More Information and Examples
top
ArrayOf
- (CkoJsonArray *)ArrayOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns nil on failure

top
BoolAt
- (BOOL)BoolAt:(NSNumber *)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).

More Information and Examples
top
BoolOf
- (BOOL)BoolOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

More Information and Examples
top
BytesOf
- (BOOL)BytesOf:(NSString *)jsonPath
    encoding:(NSString *)encoding
    bd:(CkoBinData *)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 YES for success, NO for failure.

top
Clone
- (CkoJsonObject *)Clone;
Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns nil on failure

top
DateOf
- (BOOL)DateOf:(NSString *)jsonPath
    dateTime:(CkoDateTime *)dateTime;
Introduced in version 9.5.0.73

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 YES for success, NO for failure.

More Information and Examples
top
Delete
- (BOOL)Delete:(NSString *)name;
Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns YES for success, NO for failure.

More Information and Examples
top
DeleteAt
- (BOOL)DeleteAt:(NSNumber *)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 YES for success, NO for failure.

More Information and Examples
top
DtOf
- (BOOL)DtOf:(NSString *)jsonPath
    bLocal:(BOOL)bLocal
    dt:(CkoDtObj *)dt;
Introduced in version 9.5.0.73

Fills the dt with the date/time string located at jsonPath. If bLocal is YES, 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 YES for success, NO for failure.

More Information and Examples
top
Emit
- (NSString *)Emit;
Introduced in version 9.5.0.56

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

Returns nil on failure

More Information and Examples
top
EmitSb
- (BOOL)EmitSb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns YES for success, NO for failure.

top
EmitWithSubs
- (NSString *)EmitWithSubs:(CkoHashtable *)subs
    omitEmpty:(BOOL)omitEmpty;
Introduced in version 9.5.0.67

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

Returns nil on failure

More Information and Examples
top
FindObjectWithMember
- (CkoJsonObject *)FindObjectWithMember:(NSString *)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

top
FindRecord
- (CkoJsonObject *)FindRecord:(NSString *)arrayPath
    relPath:(NSString *)relPath
    value:(NSString *)value
    caseSensitive:(BOOL)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

More Information and Examples
top
FindRecordString
- (NSString *)FindRecordString:(NSString *)arrayPath
    relPath:(NSString *)relPath
    value:(NSString *)value
    caseSensitive:(BOOL)caseSensitive
    retRelPath:(NSString *)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 nil on failure

More Information and Examples
top
FirebaseApplyEvent
- (BOOL)FirebaseApplyEvent:(NSString *)name
    data:(NSString *)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 YES for success, NO for failure.

top
FirebasePatch
- (BOOL)FirebasePatch:(NSString *)jsonPath
    jsonData:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
FirebasePut
- (BOOL)FirebasePut:(NSString *)jsonPath
    value:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
GetDocRoot
- (CkoJsonObject *)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

More Information and Examples
top
HasMember
- (BOOL)HasMember:(NSString *)jsonPath;
Introduced in version 9.5.0.58

Returns YES if the item at the jsonPath exists.

Returns YES for success, NO for failure.

top
IndexOf
- (NSNumber *)IndexOf:(NSString *)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.

More Information and Examples
top
IntAt
- (NSNumber *)IntAt:(NSNumber *)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).

More Information and Examples
top
IntOf
- (NSNumber *)IntOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

More Information and Examples
top
IsNullAt
- (BOOL)IsNullAt:(NSNumber *)index;
Introduced in version 9.5.0.56

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

More Information and Examples
top
IsNullOf
- (BOOL)IsNullOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Returns YES if the value at the specified jsonPath is null. Otherwise returns NO.

More Information and Examples
top
Load
- (BOOL)Load:(NSString *)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 YES for success, NO for failure.

top
LoadFile
- (BOOL)LoadFile:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
LoadPredefined
- (BOOL)LoadPredefined:(NSString *)name;
Introduced in version 9.5.0.67

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

Returns YES for success, NO for failure.

More Information and Examples
top
LoadSb
- (BOOL)LoadSb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns YES for success, NO for failure.

top
NameAt
- (NSString *)NameAt:(NSNumber *)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 nil on failure

More Information and Examples
top
ObjectAt
- (CkoJsonObject *)ObjectAt:(NSNumber *)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

More Information and Examples
top
ObjectOf
- (CkoJsonObject *)ObjectOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns nil on failure

More Information and Examples
top
Predefine
- (BOOL)Predefine:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
Rename
- (BOOL)Rename:(NSString *)oldName
    newName:(NSString *)newName;
Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns YES for success, NO for failure.

More Information and Examples
top
RenameAt
- (BOOL)RenameAt:(NSNumber *)index
    name:(NSString *)name;
Introduced in version 9.5.0.56

Renames the member at index to name.

Returns YES for success, NO for failure.

More Information and Examples
top
SaveLastError
- (BOOL)SaveLastError:(NSString *)path;

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

Returns YES for success, NO for failure.

top
SetBoolAt
- (BOOL)SetBoolAt:(NSNumber *)index
    value:(BOOL)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 YES for success, NO for failure.

More Information and Examples
top
SetBoolOf
- (BOOL)SetBoolOf:(NSString *)jsonPath
    value:(BOOL)value;
Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns YES for success, NO for failure.

More Information and Examples
top
SetIntAt
- (BOOL)SetIntAt:(NSNumber *)index
    value:(NSNumber *)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 YES for success, NO for failure.

More Information and Examples
top
SetIntOf
- (BOOL)SetIntOf:(NSString *)jsonPath
    value:(NSNumber *)value;
Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns YES for success, NO for failure.

More Information and Examples
top
SetNullAt
- (BOOL)SetNullAt:(NSNumber *)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 YES for success, NO for failure.

More Information and Examples
top
SetNullOf
- (BOOL)SetNullOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns YES for success, NO for failure.

More Information and Examples
top
SetNumberAt
- (BOOL)SetNumberAt:(NSNumber *)index
    value:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
SetNumberOf
- (BOOL)SetNumberOf:(NSString *)jsonPath
    value:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
SetStringAt
- (BOOL)SetStringAt:(NSNumber *)index
    value:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
SetStringOf
- (BOOL)SetStringOf:(NSString *)jsonPath
    value:(NSString *)value;
Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns YES for success, NO for failure.

More Information and Examples
top
SizeOfArray
- (NSNumber *)SizeOfArray:(NSString *)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.

More Information and Examples
top
StringAt
- (NSString *)StringAt:(NSNumber *)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 nil on failure

More Information and Examples
top
StringOf
- (NSString *)StringOf:(NSString *)jsonPath;
Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns nil on failure

top
StringOfSb
- (BOOL)StringOfSb:(NSString *)jsonPath
    sb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns YES for success, NO for failure.

top
TypeAt
- (NSNumber *)TypeAt:(NSNumber *)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.

top
UpdateBd
- (BOOL)UpdateBd:(NSString *)jsonPath
    encoding:(NSString *)encoding
    bd:(CkoBinData *)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 YES for success, NO for failure.

top
UpdateBool
- (BOOL)UpdateBool:(NSString *)jsonPath
    value:(BOOL)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 YES for success, NO for failure.

top
UpdateInt
- (BOOL)UpdateInt:(NSString *)jsonPath
    value:(NSNumber *)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 YES for success, NO for failure.

top
UpdateNewArray
- (BOOL)UpdateNewArray:(NSString *)jsonPath;
Introduced in version 9.5.0.75

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 YES for success, NO for failure.

More Information and Examples
top
UpdateNewObject
- (BOOL)UpdateNewObject:(NSString *)jsonPath;
Introduced in version 9.5.0.75

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 YES for success, NO for failure.

More Information and Examples
top
UpdateNull
- (BOOL)UpdateNull:(NSString *)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 YES for success, NO for failure.

top
UpdateNumber
- (BOOL)UpdateNumber:(NSString *)jsonPath
    numericStr:(NSString *)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 YES for success, NO for failure.

top
UpdateSb
- (BOOL)UpdateSb:(NSString *)jsonPath
    sb:(CkoStringBuilder *)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 YES for success, NO for failure.

top
UpdateString
- (BOOL)UpdateString:(NSString *)jsonPath
    value:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top