IntelligenceX

API Reference

Class

JsonObject

Edit on GitHub
Namespace IntelligenceX.Json
Assembly IntelligenceX
Source Json/JsonObject.cs:16
Implements
IEnumerable<KeyValuePair<String, JsonValue>> IEnumerable
Modifiers sealed
Attributes
DefaultMember("Item")

Represents a mutable JSON object.

Inheritance

  • Object
  • JsonObject

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

JsonObject 2 overloads
public JsonObject() #
Json/JsonObject.cs:16

Initializes an empty JSON object with ordinal key comparison.

public JsonObject(StringComparer comparer) #
Json/JsonObject.cs:22

Initializes an empty JSON object with a custom key comparer.

Parameters

comparer System.StringComparer requiredposition: 0
Comparer used for key lookup.

Methods

Add 7 overloads
public JsonObject Add(String key, JsonArray value) #
Json/JsonObject.cs:70
Returns: JsonObject

Adds or replaces a JSON value for the specified key.

Parameters

key System.String requiredposition: 0
value IntelligenceX.Json.JsonValue requiredposition: 1
public JsonObject Add(String key, String value) #
Json/JsonObject.cs:50
Returns: JsonObject

Adds or replaces a string value for the specified key.

Parameters

key System.String requiredposition: 0
value System.String requiredposition: 1
public JsonObject Add(String key, Boolean value) #
Json/JsonObject.cs:54
Returns: JsonObject

Adds or replaces a boolean value for the specified key.

Parameters

key System.String requiredposition: 0
value System.Boolean requiredposition: 1
public JsonObject Add(String key, Int64 value) #
Json/JsonObject.cs:58
Returns: JsonObject

Adds or replaces an integer value for the specified key.

Parameters

key System.String requiredposition: 0
value System.Int64 requiredposition: 1
public JsonObject Add(String key, Double value) #
Json/JsonObject.cs:62
Returns: JsonObject

Adds or replaces a double value for the specified key.

Parameters

key System.String requiredposition: 0
value System.Double requiredposition: 1
Add(System.String key, IntelligenceX.Json.JsonObject value) #

Adds or replaces a JSON object value for the specified key.

Parameters

key System.String required
value IntelligenceX.Json.JsonObject required
Add(System.String key, IntelligenceX.Json.JsonArray value) #

Adds or replaces a JSON array value for the specified key.

Parameters

key System.String required
value IntelligenceX.Json.JsonArray required
public JsonArray GetArray(String key) #
Json/JsonObject.cs:100
Returns: JsonArray

Returns a JSON array value for the specified key.

Parameters

key System.String requiredposition: 0
public Boolean GetBoolean(String key, Boolean defaultValue = false) #
Json/JsonObject.cs:92
Returns: Boolean

Returns a boolean value for the specified key or a default when missing.

Parameters

key System.String requiredposition: 0
defaultValue System.Boolean = false optionalposition: 1
public Nullable<Double> GetDouble(String key) #
Json/JsonObject.cs:88
Returns: Nullable<Double>

Returns a double value for the specified key.

Parameters

key System.String requiredposition: 0
public virtual IEnumerator<KeyValuePair<String, JsonValue>> GetEnumerator() #
Json/JsonObject.cs:105
Returns: IEnumerator<KeyValuePair<String, JsonValue>>

Returns a typed enumerator over the object's properties.

public Nullable<Int64> GetInt64(String key) #
Json/JsonObject.cs:84
Returns: Nullable<Int64>

Returns an integer value for the specified key.

Parameters

key System.String requiredposition: 0
public JsonObject GetObject(String key) #
Json/JsonObject.cs:96
Returns: JsonObject

Returns a JSON object value for the specified key.

Parameters

key System.String requiredposition: 0
public String GetString(String key) #
Json/JsonObject.cs:80
Returns: String

Returns a string value for the specified key.

Parameters

key System.String requiredposition: 0
System#Collections#IEnumerable#GetEnumerator() #

Returns a non-generic enumerator over the object's properties.

public Boolean TryGetValue(String key, out JsonValue value) #
Json/JsonObject.cs:75
Returns: Boolean

Attempts to retrieve a JSON value by key.

Parameters

key System.String requiredposition: 0
value IntelligenceX.Json.JsonValue@ requiredposition: 1

Properties

public Int32 Count { get; } #
Json/JsonObject.cs:29

Gets the number of properties in the object.

public JsonValue Item { get; set; } #
Json/JsonObject.cs:35

Gets or sets a value by property key.

Extension Methods

public static JsonObject AddIfNotEmpty(JsonObject obj, String key, JsonArray value) #
Json/JsonObjectExtensions.cs:45
Returns: JsonObject

Adds the array property only when the value is not null and contains at least one element.

Parameters

obj IntelligenceX.Json.JsonObject requiredposition: 0
Target JSON object.
key System.String requiredposition: 1
Property name.
value IntelligenceX.Json.JsonArray requiredposition: 2
Array to add when non-empty.

Returns

The same instance for fluent chaining.

public static JsonObject ExtractAdditional(JsonObject obj, params String[] knownKeys) #
Json/JsonObjectExtensions.cs:17
Returns: JsonObject

Returns a new object containing properties that are not in knownKeys.

Parameters

obj IntelligenceX.Json.JsonObject requiredposition: 0
Source JSON object.
knownKeys System.String[] requiredposition: 1
Keys to exclude from the result.

Returns

A new object containing unknown keys, or null when none exist.