Interface IJSONObject
- Namespace
- ESRI.ArcGIS.esriSystem
- Assembly
- ESRI.Server.System.dll
Provides simplified DOM-like JSON serialization and de-serialization API.
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("EEA70515-FA6B-4DEE-AB79-D7935BF3A838")]
public interface IJSONObject
Properties
CaseSensitiveNames
Returns true if member name lookups are case-sensitive. Default value is true. Methods affected by this state change: MemberExists, IsValueNull and all TryGet... methods.
bool CaseSensitiveNames { get; set; }
Property Value
MemberCount
Returns size of member collection.
int MemberCount { get; }
Property Value
Methods
Add(string, object)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void Add(string Name, object Value)
Parameters
AddBoolean(string, bool)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddBoolean(string Name, bool Value)
Parameters
AddDate(string, DateTime)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddDate(string Name, DateTime Value)
Parameters
AddDouble(string, double)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddDouble(string Name, double Value)
Parameters
AddDoubleEx(string, double, int)
Adds new member name-value pair to the member collection. Stores precision for use in ToJSON and ToJSONString. Returns E_FAIL if duplicate member is found.
void AddDoubleEx(string Name, double Value, int precision)
Parameters
AddJSONArray(string, IJSONArray)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddJSONArray(string Name, IJSONArray Value)
Parameters
NamestringValueIJSONArray
AddJSONObject(string, IJSONObject)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddJSONObject(string Name, IJSONObject Value)
Parameters
NamestringValueIJSONObject
AddLong(string, int)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddLong(string Name, int Value)
Parameters
AddNull(string)
Adds new member with the value of null to the member collection. Returns E_FAIL if duplicate member is found.
void AddNull(string Name)
Parameters
Namestring
AddString(string, string)
Adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void AddString(string Name, string Value)
Parameters
ClearAll()
Removes all members.
void ClearAll()
CreateMemberArray(string, out IJSONArray)
Creates and adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void CreateMemberArray(string Name, out IJSONArray Value)
Parameters
NamestringValueIJSONArray
CreateMemberObject(string, out IJSONObject)
Creates and adds new member name-value pair to the member collection. Returns E_FAIL if duplicate member is found.
void CreateMemberObject(string Name, out IJSONObject Value)
Parameters
NamestringValueIJSONObject
GetMemberAt(int, out string, out object)
Returns member name and value at a given index.
void GetMemberAt(int Index, out string Name, out object Value)
Parameters
IsValueNull(string)
Returns VARIANT_TRUE if member is undefined or member's value is null. Returns VARIANT_FALSE if member exists and its value is not null.
bool IsValueNull(string Name)
Parameters
Namestring
Returns
MakeValueNull(string)
Make a designated member NULL.
void MakeValueNull(string Name)
Parameters
Namestring
MemberExists(string)
Checks if a member with the given name exists.
bool MemberExists(string Name)
Parameters
Namestring
Returns
ParseJSON(IJSONReader)
Parses JSON object from IJSONReader into memory. Useful if you want to have random access to just a part of a JSON.
void ParseJSON(IJSONReader pReader)
Parameters
pReaderIJSONReader
ParseString(string)
Parses JSON object from string into memory.
void ParseString(string json)
Parameters
jsonstring
RemoveMember(string)
Remove a member from the member collection.
void RemoveMember(string Name)
Parameters
Namestring
ToJSON(string, IJSONWriter)
Converts IJSONObject to JSON representation using provided IJSONWriter. Useful when you have complex JSON response you want to combine from the output of several methods.
void ToJSON(string objectName, IJSONWriter pWriter)
Parameters
objectNamestringpWriterIJSONWriter
ToJSONString(IPropertySet)
Converts IJSONObject to JSON representation using IJSONWriter internally. 'props' parameter is to control IJSONWriter properties. It's safe to set it to NULL.
string ToJSONString(IPropertySet props)
Parameters
propsIPropertySet
Returns
TryGetValue(string, out object)
Returns member value for a given name. If member does not exist, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValue(string Name, out object Value)
Parameters
Returns
TryGetValueAsArray(string, out IJSONArray)
Returns member value for a given name as IJSONArray. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsArray(string Name, out IJSONArray Value)
Parameters
NamestringValueIJSONArray
Returns
TryGetValueAsBoolean(string, out bool)
Returns member value for a given name as boolean. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsBoolean(string Name, out bool Value)
Parameters
Returns
TryGetValueAsDate(string, out DateTime)
Returns member value for a given name as DATE. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsDate(string Name, out DateTime Value)
Parameters
Returns
TryGetValueAsDouble(string, out double)
Returns member value for a given name as double. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsDouble(string Name, out double Value)
Parameters
Returns
TryGetValueAsLong(string, out int)
Returns member value for a given name as long. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsLong(string Name, out int Value)
Parameters
Returns
TryGetValueAsObject(string, out IJSONObject)
Returns member value for a given name as IJSONObject. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsObject(string Name, out IJSONObject Value)
Parameters
NamestringValueIJSONObject
Returns
TryGetValueAsString(string, out string)
Returns member value for a given name as string. If member does not exist or type coercion fails, returns VARIANT_FALSE in 'success' parameter.
bool TryGetValueAsString(string Name, out string Value)