JsonDocument

Overview

Root node of json data

Location

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

 

constructor .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

 

constructor

 

JsonDocument()

 

init()

 

JsonDocument()

 

Sub New()

constructor init() Toffee

 

init(init )

Parameters:

  • :

constructor (not nullable JsonNode)

 

constructor(aRoot: not nullable JsonNode)

 

JsonDocument(JsonNode! aRoot)

 

init(_ aRoot: JsonNode)

 

JsonDocument(JsonNode aRoot)

 

Sub New(aRoot As JsonNode)

Parameters:

  • aRoot:

CreateDocument .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Create a new json document.

 

class method CreateDocument: not nullable JsonDocument

 

static JsonDocument! CreateDocument()

 

static func CreateDocument() -> JsonDocument

 

static JsonDocument CreateDocument()

 

Shared Function CreateDocument() As JsonDocument

CreateDocument CreateDocument(): not nullable JsonDocument  virtual Toffee

 

static func CreateDocument(CreateDocument ) -> JsonDocument

Parameters:

  • :

description  override ToffeeV2

Converts this json document to string.

 

func description() -> NSString

description description(): NSString  override Toffee

 

func description(description ) -> NSString

Parameters:

  • :

FromBinary (not nullable array of Byte, Encoding): not nullable JsonDocument

 

class method FromBinary(aBinary: not nullable array of Byte; aEncoding: Encoding): not nullable JsonDocument

 

static JsonDocument! FromBinary(Byte[]! aBinary, Encoding aEncoding)

 

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

 

static JsonDocument FromBinary(Byte[] aBinary, Encoding aEncoding)

 

Shared Function FromBinary(aBinary As Byte(), aEncoding As Encoding) As JsonDocument

Parameters:

  • aBinary:
  • aEncoding:

FromBinary (not nullable ImmutableBinary, Encoding): not nullable JsonDocument

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)

 

Shared Function FromBinary(aBinary As ImmutableBinary, aEncoding As Encoding) As JsonDocument

Parameters:

  • aBinary:
  • aEncoding:

FromFile .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, 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)

 

Shared Function FromFile(aFile As File) As JsonDocument

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)

 

Shared Function FromString(aString As String) As JsonDocument

Parameters:

  • aString:

FromUrl .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

class method FromUrl(aUrl: not nullable Url): not nullable JsonDocument

 

static JsonDocument! FromUrl(Url! aUrl)

 

static func FromUrl(_ aUrl: Url) -> JsonDocument

 

static JsonDocument FromUrl(Url aUrl)

 

Shared Function FromUrl(aUrl As Url) As JsonDocument

Parameters:

  • aUrl:

Item  virtual

 

property Item[aIndex: Int32]: nullable JsonNode read;

 

JsonNode? Item[Int32 aIndex] { get; }

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
subscript Item(_ aIndex: Int32) -> JsonNode? { get{} }
// Toffee
subscript Item(_ aIndex: Int32) -> JsonNode { get{} }

 

JsonNode Item[Integer aIndex] { __get; }

 

ReadOnly Property Item(aIndex As Int32) As JsonNode?

Item  virtual

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

 

property Item[aKey: not nullable String]: nullable JsonNode read write;

 

JsonNode? Item[String! aKey] { get; set; }

 

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

 

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

 

Property Item(aKey As String) As JsonNode?

Item  virtual

 

property Item[aKey: not nullable String]: Boolean write;

 

Boolean Item[String! aKey] { set; }

 

subscript Item(_ aKey: String) -> Boolean { set{} }

 

Boolean Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As Boolean

Item  virtual

 

property Item[aKey: not nullable String]: Double write;

 

Double Item[String! aKey] { set; }

 

subscript Item(_ aKey: String) -> Double { set{} }

 

Double Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As Double

Item  virtual

 

property Item[aKey: not nullable String]: Int32 write;

 

Int32 Item[String! aKey] { set; }

 

subscript Item(_ aKey: String) -> Int32 { set{} }

 

Integer Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As Int32

Item  virtual

 

property Item[aKey: not nullable String]: nullable String write;

 

String? Item[String! aKey] { set; }

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
subscript Item(_ aKey: String) -> String? { set{} }
// Toffee
subscript Item(_ aKey: String) -> String { set{} }

 

String Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As String?

Keys  virtual

Returns all keys in this document.

 

property Keys: not nullable IEnumerable<String> read;

 

IEnumerable<String>! Keys { get; }

 

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

 

Iterable<String> Keys { __get; }

 

ReadOnly Property Keys() As IEnumerable<String>

Root

Returns the root node.

 

property Root: not nullable JsonNode read;

 

JsonNode! Root { get; }

 

var Root: JsonNode { get{} }

 

JsonNode Root { __get; }

 

ReadOnly Property Root() As JsonNode

RootObject

Returns the root node.

 

property RootObject: not nullable JsonObject read;

 

JsonObject! RootObject { get; }

 

var RootObject: JsonObject { get{} }

 

JsonObject RootObject { __get; }

 

ReadOnly Property RootObject() As JsonObject

ToJson

 

method ToJson(aFormat: JsonFormat): String

 

String ToJson(JsonFormat aFormat)

 

func ToJson(_ aFormat: JsonFormat) -> String

 

String ToJson(JsonFormat aFormat)

 

Function ToJson(aFormat As JsonFormat) As String

Parameters:

  • aFormat:

toString Cooper

 

method toString: PlatformString

 

PlatformString toString()

 

func toString() -> PlatformString

 

PlatformString toString()

 

Function toString() As PlatformString

ToString  virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2

Converts this json document to string.

 

method ToString: PlatformString

 

PlatformString ToString()

 

func ToString() -> String

 

Function ToString() As PlatformString

ToString ToString(): String  virtual Toffee

 

func ToString(ToString ) -> String

Parameters:

  • :

TryFromBinary (nullable array of Byte, Encoding): nullable JsonDocument

 

class method TryFromBinary(aBinary: nullable array of Byte; aEncoding: Encoding): nullable JsonDocument

 

static JsonDocument? TryFromBinary(Byte[]? aBinary, Encoding aEncoding)

 

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

 

static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding)

 

Shared Function TryFromBinary(aBinary As Byte()?, aEncoding As Encoding) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:

TryFromBinary (nullable array of Byte, Encoding, Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
class method TryFromBinary(aBinary: nullable array of Byte; aEncoding: Encoding; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromBinary(aBinary: nullable array of Byte; aEncoding: Encoding; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
static JsonDocument? TryFromBinary(Byte[]? aBinary, Encoding aEncoding, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromBinary(Byte[]? aBinary, Encoding aEncoding, out Exception aException)

 

// Toffee
static func TryFromBinary(_ aBinary: Byte..., _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: Byte...?, _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument?

 

static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Shared Function TryFromBinary(aBinary As Byte()?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromBinary(aBinary As Byte()?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:
  • aException:

TryFromBinary (nullable ImmutableBinary, Encoding): nullable JsonDocument

Parse json from a binary.

 

class method TryFromBinary(aBinary: 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)

 

Shared Function TryFromBinary(aBinary As ImmutableBinary?, aEncoding As Encoding) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:

TryFromBinary (nullable ImmutableBinary, Encoding, Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
class method TryFromBinary(aBinary: nullable ImmutableBinary; aEncoding: Encoding; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromBinary(aBinary: nullable ImmutableBinary; aEncoding: Encoding; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
static JsonDocument? TryFromBinary(ImmutableBinary? aBinary, Encoding aEncoding, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromBinary(ImmutableBinary? aBinary, Encoding aEncoding, out Exception aException)

 

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

 

static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Shared Function TryFromBinary(aBinary As ImmutableBinary?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromBinary(aBinary As ImmutableBinary?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:
  • aException:

TryFromFile (not nullable File): nullable JsonDocument .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, 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)

 

Shared Function TryFromFile(aFile As File) As JsonDocument?

Parameters:

  • aFile:

TryFromFile (not nullable File, Exception): nullable JsonDocument .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-Windows
class method TryFromFile(aFile: not nullable File; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromFile(aFile: not nullable File; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-Windows
static JsonDocument? TryFromFile(File! aFile, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromFile(File! aFile, out Exception aException)

 

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

 

static JsonDocument TryFromFile(File aFile, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-Windows
Shared Function TryFromFile(aFile As File, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromFile(aFile As File, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aFile:
  • aException:

TryFromString (nullable String): nullable JsonDocument

Parse json from a string.

 

class method TryFromString(aString: 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)

 

Shared Function TryFromString(aString As String?) As JsonDocument?

Parameters:

  • aString:

TryFromString (nullable String, Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
class method TryFromString(aString: nullable String; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromString(aString: nullable String; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
static JsonDocument? TryFromString(String? aString, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromString(String? aString, out Exception aException)

 

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

 

static JsonDocument TryFromString(String aString, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Shared Function TryFromString(aString As String?, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromString(aString As String?, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aString:
  • aException:

 

Item  virtual

 

property Item[aIndex: Int32]: nullable JsonNode read;

 

JsonNode? Item[Int32 aIndex] { get; }

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
subscript Item(_ aIndex: Int32) -> JsonNode? { get{} }
// Toffee
subscript Item(_ aIndex: Int32) -> JsonNode { get{} }

 

JsonNode Item[Integer aIndex] { __get; }

 

ReadOnly Property Item(aIndex As Int32) As JsonNode?

Item  virtual

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

 

property Item[aKey: not nullable String]: nullable JsonNode read write;

 

JsonNode? Item[String! aKey] { get; set; }

 

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

 

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

 

Property Item(aKey As String) As JsonNode?

Item  virtual

 

property Item[aKey: not nullable String]: Boolean write;

 

Boolean Item[String! aKey] { set; }

 

subscript Item(_ aKey: String) -> Boolean { set{} }

 

Boolean Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As Boolean

Item  virtual

 

property Item[aKey: not nullable String]: Double write;

 

Double Item[String! aKey] { set; }

 

subscript Item(_ aKey: String) -> Double { set{} }

 

Double Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As Double

Item  virtual

 

property Item[aKey: not nullable String]: Int32 write;

 

Int32 Item[String! aKey] { set; }

 

subscript Item(_ aKey: String) -> Int32 { set{} }

 

Integer Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As Int32

Item  virtual

 

property Item[aKey: not nullable String]: nullable String write;

 

String? Item[String! aKey] { set; }

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
subscript Item(_ aKey: String) -> String? { set{} }
// Toffee
subscript Item(_ aKey: String) -> String { set{} }

 

String Item[String aKey] { __set; }

 

WriteOnly Property Item(aKey As String) As String?

Keys  virtual

Returns all keys in this document.

 

property Keys: not nullable IEnumerable<String> read;

 

IEnumerable<String>! Keys { get; }

 

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

 

Iterable<String> Keys { __get; }

 

ReadOnly Property Keys() As IEnumerable<String>

Root

Returns the root node.

 

property Root: not nullable JsonNode read;

 

JsonNode! Root { get; }

 

var Root: JsonNode { get{} }

 

JsonNode Root { __get; }

 

ReadOnly Property Root() As JsonNode

RootObject

Returns the root node.

 

property RootObject: not nullable JsonObject read;

 

JsonObject! RootObject { get; }

 

var RootObject: JsonObject { get{} }

 

JsonObject RootObject { __get; }

 

ReadOnly Property RootObject() As JsonObject

 

CreateDocument .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Create a new json document.

 

class method CreateDocument: not nullable JsonDocument

 

static JsonDocument! CreateDocument()

 

static func CreateDocument() -> JsonDocument

 

static JsonDocument CreateDocument()

 

Shared Function CreateDocument() As JsonDocument

CreateDocument CreateDocument(): not nullable JsonDocument  virtual Toffee

 

static func CreateDocument(CreateDocument ) -> JsonDocument

Parameters:

  • :

FromBinary (not nullable array of Byte, Encoding): not nullable JsonDocument

 

class method FromBinary(aBinary: not nullable array of Byte; aEncoding: Encoding): not nullable JsonDocument

 

static JsonDocument! FromBinary(Byte[]! aBinary, Encoding aEncoding)

 

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

 

static JsonDocument FromBinary(Byte[] aBinary, Encoding aEncoding)

 

Shared Function FromBinary(aBinary As Byte(), aEncoding As Encoding) As JsonDocument

Parameters:

  • aBinary:
  • aEncoding:

FromBinary (not nullable ImmutableBinary, Encoding): not nullable JsonDocument

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)

 

Shared Function FromBinary(aBinary As ImmutableBinary, aEncoding As Encoding) As JsonDocument

Parameters:

  • aBinary:
  • aEncoding:

FromFile .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, 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)

 

Shared Function FromFile(aFile As File) As JsonDocument

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)

 

Shared Function FromString(aString As String) As JsonDocument

Parameters:

  • aString:

FromUrl .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

class method FromUrl(aUrl: not nullable Url): not nullable JsonDocument

 

static JsonDocument! FromUrl(Url! aUrl)

 

static func FromUrl(_ aUrl: Url) -> JsonDocument

 

static JsonDocument FromUrl(Url aUrl)

 

Shared Function FromUrl(aUrl As Url) As JsonDocument

Parameters:

  • aUrl:

TryFromBinary (nullable array of Byte, Encoding): nullable JsonDocument

 

class method TryFromBinary(aBinary: nullable array of Byte; aEncoding: Encoding): nullable JsonDocument

 

static JsonDocument? TryFromBinary(Byte[]? aBinary, Encoding aEncoding)

 

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

 

static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding)

 

Shared Function TryFromBinary(aBinary As Byte()?, aEncoding As Encoding) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:

TryFromBinary (nullable array of Byte, Encoding, Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
class method TryFromBinary(aBinary: nullable array of Byte; aEncoding: Encoding; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromBinary(aBinary: nullable array of Byte; aEncoding: Encoding; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
static JsonDocument? TryFromBinary(Byte[]? aBinary, Encoding aEncoding, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromBinary(Byte[]? aBinary, Encoding aEncoding, out Exception aException)

 

// Toffee
static func TryFromBinary(_ aBinary: Byte..., _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: Byte...?, _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument?

 

static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Shared Function TryFromBinary(aBinary As Byte()?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromBinary(aBinary As Byte()?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:
  • aException:

TryFromBinary (nullable ImmutableBinary, Encoding): nullable JsonDocument

Parse json from a binary.

 

class method TryFromBinary(aBinary: 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)

 

Shared Function TryFromBinary(aBinary As ImmutableBinary?, aEncoding As Encoding) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:

TryFromBinary (nullable ImmutableBinary, Encoding, Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
class method TryFromBinary(aBinary: nullable ImmutableBinary; aEncoding: Encoding; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromBinary(aBinary: nullable ImmutableBinary; aEncoding: Encoding; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
static JsonDocument? TryFromBinary(ImmutableBinary? aBinary, Encoding aEncoding, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromBinary(ImmutableBinary? aBinary, Encoding aEncoding, out Exception aException)

 

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

 

static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Shared Function TryFromBinary(aBinary As ImmutableBinary?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromBinary(aBinary As ImmutableBinary?, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aBinary:
  • aEncoding:
  • aException:

TryFromFile (not nullable File): nullable JsonDocument .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, 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)

 

Shared Function TryFromFile(aFile As File) As JsonDocument?

Parameters:

  • aFile:

TryFromFile (not nullable File, Exception): nullable JsonDocument .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-Windows
class method TryFromFile(aFile: not nullable File; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromFile(aFile: not nullable File; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-Windows
static JsonDocument? TryFromFile(File! aFile, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromFile(File! aFile, out Exception aException)

 

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

 

static JsonDocument TryFromFile(File aFile, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-Windows
Shared Function TryFromFile(aFile As File, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromFile(aFile As File, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aFile:
  • aException:

TryFromString (nullable String): nullable JsonDocument

Parse json from a string.

 

class method TryFromString(aString: 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)

 

Shared Function TryFromString(aString As String?) As JsonDocument?

Parameters:

  • aString:

TryFromString (nullable String, Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
class method TryFromString(aString: nullable String; out aException: Exception): nullable JsonDocument
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
class method TryFromString(aString: nullable String; out aException: Exception): nullable JsonDocument

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
static JsonDocument? TryFromString(String? aString, out Exception aException)
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
static JsonDocument? TryFromString(String? aString, out Exception aException)

 

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

 

static JsonDocument TryFromString(String aString, __out Exception aException)

 

// .NET, .NET Core 6.0, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Shared Function TryFromString(aString As String?, <OutAttribute> ByRef aException As Exception) As JsonDocument?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-visionOS, Island-visionOS Simulator, Island-watchOS, Island-watchOS Simulator
Shared Function TryFromString(aString As String?, <OutAttribute> ByRef aException As Exception) As JsonDocument?

Parameters:

  • aString:
  • aException:

 

constructor .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

 

constructor

 

JsonDocument()

 

init()

 

JsonDocument()

 

Sub New()

constructor init() Toffee

 

init(init )

Parameters:

  • :

constructor (not nullable JsonNode)

 

constructor(aRoot: not nullable JsonNode)

 

JsonDocument(JsonNode! aRoot)

 

init(_ aRoot: JsonNode)

 

JsonDocument(JsonNode aRoot)

 

Sub New(aRoot As JsonNode)

Parameters:

  • aRoot:

description  override ToffeeV2

Converts this json document to string.

 

func description() -> NSString

description description(): NSString  override Toffee

 

func description(description ) -> NSString

Parameters:

  • :

ToJson

 

method ToJson(aFormat: JsonFormat): String

 

String ToJson(JsonFormat aFormat)

 

func ToJson(_ aFormat: JsonFormat) -> String

 

String ToJson(JsonFormat aFormat)

 

Function ToJson(aFormat As JsonFormat) As String

Parameters:

  • aFormat:

toString Cooper

 

method toString: PlatformString

 

PlatformString toString()

 

func toString() -> PlatformString

 

PlatformString toString()

 

Function toString() As PlatformString

ToString  virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2

Converts this json document to string.

 

method ToString: PlatformString

 

PlatformString ToString()

 

func ToString() -> String

 

Function ToString() As PlatformString

ToString ToString(): String  virtual Toffee

 

func ToString(ToString ) -> String

Parameters:

  • :