JsonDocument

Overview

Root node of json data

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL

 

constructor .NET, .NET Standard 2.0, Cooper, Island, Toffee

Create a new instance.

 

constructor

 

JsonDocument()

 

init()

 

JsonDocument()

constructor (not nullable JsonNode): InstanceType .NET, .NET Standard 2.0, Cooper, Island, Toffee

Creates a new json document with the given node as root element.

 

constructor(aRoot: not nullable JsonNode)

 

JsonDocument(JsonNode! aRoot)

 

init(_ aRoot: JsonNode)

 

JsonDocument(JsonNode! aRoot)

Parameters:

  • aRoot:

constructor init ToffeeV2

Create a new instance.

 

func constructor init()

constructor init (not nullable JsonNode) ToffeeV2

Creates a new json document with the given node as root element.

 

func constructor init(_ aRoot: JsonNode)

Parameters:

  • aRoot:

CreateDocument

Create a new json document.

 

class method CreateDocument: not nullable JsonDocument

 

static JsonDocument! CreateDocument()

 

static func CreateDocument() -> JsonDocument

 

static JsonDocument! CreateDocument()

description  override Toffee, ToffeeV2

Converts this json document to string.

 

func description() -> NSString

FromBinary

Parse json from a binary.

 

class method FromBinary(aBinary: not nullable ImmutableBinary; aEncoding: Encoding): not nullable JsonDocument

 

static JsonDocument! FromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

 

static func FromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument

 

static JsonDocument! FromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

Parameters:

  • aBinary:
  • aEncoding:

FromFile .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Parse json from a file.

 

class method FromFile(aFile: not nullable File): not nullable JsonDocument

 

static JsonDocument! FromFile(File! aFile)

 

static func FromFile(_ aFile: File) -> JsonDocument

 

static JsonDocument! FromFile(File! aFile)

Parameters:

  • aFile:

FromString

Parse json from a string.

 

class method FromString(aString: not nullable String): not nullable JsonDocument

 

static JsonDocument! FromString(String! aString)

 

static func FromString(_ aString: String) -> JsonDocument

 

static JsonDocument! FromString(String! aString)

Parameters:

  • aString:

Item  virtual

Returns the item by key name.

 

property Item[Key: String]: nullable JsonNode read write;

 

JsonNode? Item[String Key] { get; set; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
subscript Item(_ Key: String) -> JsonNode? { get{} set{} }
// Toffee
subscript Item(_ Key: String) -> JsonNode { get{} set{} }

 

JsonNode Item[String Key] { __get; __set; }

Keys  virtual

Returns all keys in this document.

 

property Keys: not nullable IEnumerable<String> read;

 

IEnumerable<String>! Keys { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
var Keys: IEnumerable<String> { get{} }
// Toffee
var Keys: INSFastEnumeration<String> { get{} }

 

Iterable<String>! Keys { __get; }

Root

Returns the root node.

 

property Root: not nullable JsonNode read;

 

JsonNode! Root { get; }

 

var Root: JsonNode { get{} }

 

JsonNode! Root { __get; }

RootObject

Returns the root node.

 

property RootObject: not nullable JsonObject read;

 

JsonObject! RootObject { get; }

 

var RootObject: JsonObject { get{} }

 

JsonObject! RootObject { __get; }

ToJson

Convert this to string.

 

method ToJson: String

 

String ToJson()

 

func ToJson() -> String

 

String ToJson()

ToString  virtual

Converts this json document to string.

 

method ToString: PlatformString

 

PlatformString ToString()

 

func ToString() -> String

 

PlatformString ToString()

TryFromBinary

Parse json from a binary.

 

class method TryFromBinary(aBinary: not nullable ImmutableBinary; aEncoding: Encoding): nullable JsonDocument

 

static JsonDocument? TryFromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

 

// Toffee
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument?

 

static JsonDocument TryFromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

Parameters:

  • aBinary:
  • aEncoding:

TryFromFile .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Parse json from a file.

 

class method TryFromFile(aFile: not nullable File): nullable JsonDocument

 

static JsonDocument? TryFromFile(File! aFile)

 

// Toffee
static func TryFromFile(_ aFile: File) -> JsonDocument
// ToffeeV2
static func TryFromFile(_ aFile: File) -> JsonDocument?

 

static JsonDocument TryFromFile(File! aFile)

Parameters:

  • aFile:

TryFromString

Parse json from a string.

 

class method TryFromString(aString: not nullable String): nullable JsonDocument

 

static JsonDocument? TryFromString(String! aString)

 

// Toffee
static func TryFromString(_ aString: String) -> JsonDocument
// ToffeeV2
static func TryFromString(_ aString: String) -> JsonDocument?

 

static JsonDocument TryFromString(String! aString)

Parameters:

  • aString:

 

Item  virtual

Returns the item by key name.

 

property Item[Key: String]: nullable JsonNode read write;

 

JsonNode? Item[String Key] { get; set; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
subscript Item(_ Key: String) -> JsonNode? { get{} set{} }
// Toffee
subscript Item(_ Key: String) -> JsonNode { get{} set{} }

 

JsonNode Item[String Key] { __get; __set; }

Keys  virtual

Returns all keys in this document.

 

property Keys: not nullable IEnumerable<String> read;

 

IEnumerable<String>! Keys { get; }

 

// .NET, .NET Standard 2.0, Island, ToffeeV2
var Keys: IEnumerable<String> { get{} }
// Toffee
var Keys: INSFastEnumeration<String> { get{} }

 

Iterable<String>! Keys { __get; }

Root

Returns the root node.

 

property Root: not nullable JsonNode read;

 

JsonNode! Root { get; }

 

var Root: JsonNode { get{} }

 

JsonNode! Root { __get; }

RootObject

Returns the root node.

 

property RootObject: not nullable JsonObject read;

 

JsonObject! RootObject { get; }

 

var RootObject: JsonObject { get{} }

 

JsonObject! RootObject { __get; }

 

CreateDocument

Create a new json document.

 

class method CreateDocument: not nullable JsonDocument

 

static JsonDocument! CreateDocument()

 

static func CreateDocument() -> JsonDocument

 

static JsonDocument! CreateDocument()

FromBinary

Parse json from a binary.

 

class method FromBinary(aBinary: not nullable ImmutableBinary; aEncoding: Encoding): not nullable JsonDocument

 

static JsonDocument! FromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

 

static func FromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument

 

static JsonDocument! FromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

Parameters:

  • aBinary:
  • aEncoding:

FromFile .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Parse json from a file.

 

class method FromFile(aFile: not nullable File): not nullable JsonDocument

 

static JsonDocument! FromFile(File! aFile)

 

static func FromFile(_ aFile: File) -> JsonDocument

 

static JsonDocument! FromFile(File! aFile)

Parameters:

  • aFile:

FromString

Parse json from a string.

 

class method FromString(aString: not nullable String): not nullable JsonDocument

 

static JsonDocument! FromString(String! aString)

 

static func FromString(_ aString: String) -> JsonDocument

 

static JsonDocument! FromString(String! aString)

Parameters:

  • aString:

TryFromBinary

Parse json from a binary.

 

class method TryFromBinary(aBinary: not nullable ImmutableBinary; aEncoding: Encoding): nullable JsonDocument

 

static JsonDocument? TryFromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

 

// Toffee
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument?

 

static JsonDocument TryFromBinary(ImmutableBinary! aBinary, Encoding aEncoding)

Parameters:

  • aBinary:
  • aEncoding:

TryFromFile .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Parse json from a file.

 

class method TryFromFile(aFile: not nullable File): nullable JsonDocument

 

static JsonDocument? TryFromFile(File! aFile)

 

// Toffee
static func TryFromFile(_ aFile: File) -> JsonDocument
// ToffeeV2
static func TryFromFile(_ aFile: File) -> JsonDocument?

 

static JsonDocument TryFromFile(File! aFile)

Parameters:

  • aFile:

TryFromString

Parse json from a string.

 

class method TryFromString(aString: not nullable String): nullable JsonDocument

 

static JsonDocument? TryFromString(String! aString)

 

// Toffee
static func TryFromString(_ aString: String) -> JsonDocument
// ToffeeV2
static func TryFromString(_ aString: String) -> JsonDocument?

 

static JsonDocument TryFromString(String! aString)

Parameters:

  • aString:

 

constructor .NET, .NET Standard 2.0, Cooper, Island, Toffee

Create a new instance.

 

constructor

 

JsonDocument()

 

init()

 

JsonDocument()

constructor init ToffeeV2

Create a new instance.

 

func constructor init()

constructor init (not nullable JsonNode) ToffeeV2

Creates a new json document with the given node as root element.

 

func constructor init(_ aRoot: JsonNode)

Parameters:

  • aRoot:

constructor (not nullable JsonNode): InstanceType .NET, .NET Standard 2.0, Cooper, Island, Toffee

Creates a new json document with the given node as root element.

 

constructor(aRoot: not nullable JsonNode)

 

JsonDocument(JsonNode! aRoot)

 

init(_ aRoot: JsonNode)

 

JsonDocument(JsonNode! aRoot)

Parameters:

  • aRoot:

description  override Toffee, ToffeeV2

Converts this json document to string.

 

func description() -> NSString

ToJson

Convert this to string.

 

method ToJson: String

 

String ToJson()

 

func ToJson() -> String

 

String ToJson()

ToString  virtual

Converts this json document to string.

 

method ToString: PlatformString

 

PlatformString ToString()

 

func ToString() -> String

 

PlatformString ToString()