HttpResponse

Overview

Response class for HTTP requests. This holds the response received from the server.

Location

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


 

Code

Http code.

 

property Code: Int32 read;

 

Int32 Code { get; }

 

var Code: Int32 { get{} }

 

Integer Code { __get; }

 

ReadOnly Property Code() As Int32

Dispose .NET, .NET Standard 2.0, Island, ToffeeV2

Dispose this class and resources attached to it.

 

method Dispose

 

void Dispose()

 

func Dispose()

 

Sub Dispose()

Exception

Exception retrieving this request.

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
property Exception: nullable Exception read write;
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator
property Exception: nullable Exception read write;

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Exception? Exception { get; set; }
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator
Exception? Exception { get; set; }

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
var Exception: Exception? { get{} set{} }
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator, ToffeeV2
var Exception: Exception? { get{} set{} }
// Toffee
var Exception: Exception { get{} set{} }

 

Exception Exception { __get; __set; }

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Property Exception() As Exception?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator
Property Exception() As Exception?

GetContentAsBinary

Returns the response as binary.

 

method GetContentAsBinary(contentCallback: not nullable HttpContentResponseBlock<ImmutableBinary>)

 

void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary>! contentCallback)

 

func GetContentAsBinary(_ contentCallback: HttpContentResponseBlock<ImmutableBinary>)

 

void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary> contentCallback)

 

Sub GetContentAsBinary(contentCallback As HttpContentResponseBlock<ImmutableBinary>)

Parameters:

  • contentCallback:

GetContentAsBinarySynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Returns the response as binary.

 

method GetContentAsBinarySynchronous: not nullable ImmutableBinary

 

ImmutableBinary! GetContentAsBinarySynchronous()

 

func GetContentAsBinarySynchronous() -> ImmutableBinary

 

ImmutableBinary GetContentAsBinarySynchronous()

 

Function GetContentAsBinarySynchronous() As ImmutableBinary

GetContentAsBinarySynchronous GetContentAsBinarySynchronous(): not nullable ImmutableBinary  virtual Toffee

 

func GetContentAsBinarySynchronous(GetContentAsBinarySynchronous ) -> ImmutableBinary

Parameters:

  • :

GetContentAsJson

Returns the response as json.

 

method GetContentAsJson(contentCallback: not nullable HttpContentResponseBlock<JsonDocument>)

 

void GetContentAsJson(HttpContentResponseBlock<JsonDocument>! contentCallback)

 

func GetContentAsJson(_ contentCallback: HttpContentResponseBlock<JsonDocument>)

 

void GetContentAsJson(HttpContentResponseBlock<JsonDocument> contentCallback)

 

Sub GetContentAsJson(contentCallback As HttpContentResponseBlock<JsonDocument>)

Parameters:

  • contentCallback:

GetContentAsJsonSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Returns the response as json.

 

method GetContentAsJsonSynchronous: not nullable JsonDocument

 

JsonDocument! GetContentAsJsonSynchronous()

 

func GetContentAsJsonSynchronous() -> JsonDocument

 

JsonDocument GetContentAsJsonSynchronous()

 

Function GetContentAsJsonSynchronous() As JsonDocument

GetContentAsJsonSynchronous GetContentAsJsonSynchronous(): not nullable JsonDocument  virtual Toffee

 

func GetContentAsJsonSynchronous(GetContentAsJsonSynchronous ) -> JsonDocument

Parameters:

  • :

GetContentAsString

Returns the response as string.

 

method GetContentAsString(aEncoding: Encoding; contentCallback: not nullable HttpContentResponseBlock<String>)

 

void GetContentAsString(Encoding aEncoding, HttpContentResponseBlock<String>! contentCallback)

 

func GetContentAsString(_ aEncoding: Encoding, _ contentCallback: HttpContentResponseBlock<String>)

 

void GetContentAsString(Encoding aEncoding, HttpContentResponseBlock<String> contentCallback)

 

Sub GetContentAsString(aEncoding As Encoding, contentCallback As HttpContentResponseBlock<String>)

Parameters:

  • aEncoding:
  • contentCallback:

GetContentAsStringSynchronous

Returns the response as string.

 

method GetContentAsStringSynchronous(aEncoding: Encoding): not nullable String

 

String! GetContentAsStringSynchronous(Encoding aEncoding)

 

func GetContentAsStringSynchronous(_ aEncoding: Encoding) -> String

 

String GetContentAsStringSynchronous(Encoding aEncoding)

 

Function GetContentAsStringSynchronous(aEncoding As Encoding) As String

Parameters:

  • aEncoding:

GetContentAsXml

Returns the response as xml.

 

method GetContentAsXml(contentCallback: not nullable HttpContentResponseBlock<XmlDocument>)

 

void GetContentAsXml(HttpContentResponseBlock<XmlDocument>! contentCallback)

 

func GetContentAsXml(_ contentCallback: HttpContentResponseBlock<XmlDocument>)

 

void GetContentAsXml(HttpContentResponseBlock<XmlDocument> contentCallback)

 

Sub GetContentAsXml(contentCallback As HttpContentResponseBlock<XmlDocument>)

Parameters:

  • contentCallback:

GetContentAsXmlSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Returns the response as xml.

 

method GetContentAsXmlSynchronous: not nullable XmlDocument

 

XmlDocument! GetContentAsXmlSynchronous()

 

func GetContentAsXmlSynchronous() -> XmlDocument

 

XmlDocument GetContentAsXmlSynchronous()

 

Function GetContentAsXmlSynchronous() As XmlDocument

GetContentAsXmlSynchronous GetContentAsXmlSynchronous(): not nullable XmlDocument  virtual Toffee

 

func GetContentAsXmlSynchronous(GetContentAsXmlSynchronous ) -> XmlDocument

Parameters:

  • :

Headers

 

property Headers: not nullable ImmutableDictionary<String, String> read;

 

ImmutableDictionary<String, String>! Headers { get; }

 

var Headers: ImmutableDictionary<String, String> { get{} }

 

ImmutableDictionary<String, String> Headers { __get; }

 

ReadOnly Property Headers() As ImmutableDictionary<String, String>

SaveContentAsFile

 

method SaveContentAsFile(aTargetFile: not nullable String; contentCallback: not nullable HttpContentResponseBlock<File>)

 

void SaveContentAsFile(String! aTargetFile, HttpContentResponseBlock<File>! contentCallback)

 

func SaveContentAsFile(_ aTargetFile: String, _ contentCallback: HttpContentResponseBlock<File>)

 

void SaveContentAsFile(String aTargetFile, HttpContentResponseBlock<File> contentCallback)

 

Sub SaveContentAsFile(aTargetFile As String, contentCallback As HttpContentResponseBlock<File>)

Parameters:

  • aTargetFile:
  • contentCallback:

SaveContentAsFileSynchronous

Save the response content to a file.

 

method SaveContentAsFileSynchronous(aTargetFile: File)

 

void SaveContentAsFileSynchronous(File aTargetFile)

 

func SaveContentAsFileSynchronous(_ aTargetFile: File)

 

void SaveContentAsFileSynchronous(File aTargetFile)

 

Sub SaveContentAsFileSynchronous(aTargetFile As File)

Parameters:

  • aTargetFile:

Success

True if this response is a success response.

 

property Success: Boolean read;

 

Boolean Success { get; }

 

var Success: Boolean { get{} }

 

Boolean Success { __get; }

 

ReadOnly Property Success() As Boolean

TryGetContentAsJsonSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Gets the content as json, returning null for failure.

 

method TryGetContentAsJsonSynchronous: nullable JsonDocument

 

JsonDocument? TryGetContentAsJsonSynchronous()

 

func TryGetContentAsJsonSynchronous() -> JsonDocument?

 

JsonDocument TryGetContentAsJsonSynchronous()

 

Function TryGetContentAsJsonSynchronous() As JsonDocument?

TryGetContentAsJsonSynchronous TryGetContentAsJsonSynchronous(): JsonDocument  virtual Toffee

 

func TryGetContentAsJsonSynchronous(TryGetContentAsJsonSynchronous ) -> JsonDocument

Parameters:

  • :

TryGetContentAsXmlSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Gets the content as xml, returning null for failure.

 

method TryGetContentAsXmlSynchronous: nullable XmlDocument

 

XmlDocument? TryGetContentAsXmlSynchronous()

 

func TryGetContentAsXmlSynchronous() -> XmlDocument?

 

XmlDocument TryGetContentAsXmlSynchronous()

 

Function TryGetContentAsXmlSynchronous() As XmlDocument?

TryGetContentAsXmlSynchronous TryGetContentAsXmlSynchronous(): XmlDocument  virtual Toffee

 

func TryGetContentAsXmlSynchronous(TryGetContentAsXmlSynchronous ) -> XmlDocument

Parameters:

  • :

 

Code

Http code.

 

property Code: Int32 read;

 

Int32 Code { get; }

 

var Code: Int32 { get{} }

 

Integer Code { __get; }

 

ReadOnly Property Code() As Int32

Exception

Exception retrieving this request.

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
property Exception: nullable Exception read write;
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator
property Exception: nullable Exception read write;

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Exception? Exception { get; set; }
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator
Exception? Exception { get; set; }

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
var Exception: Exception? { get{} set{} }
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator, ToffeeV2
var Exception: Exception? { get{} set{} }
// Toffee
var Exception: Exception { get{} set{} }

 

Exception Exception { __get; __set; }

 

// .NET, .NET Standard 2.0, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows
Property Exception() As Exception?
// Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-watchOS, Island-watchOS Simulator
Property Exception() As Exception?

Headers

 

property Headers: not nullable ImmutableDictionary<String, String> read;

 

ImmutableDictionary<String, String>! Headers { get; }

 

var Headers: ImmutableDictionary<String, String> { get{} }

 

ImmutableDictionary<String, String> Headers { __get; }

 

ReadOnly Property Headers() As ImmutableDictionary<String, String>

Success

True if this response is a success response.

 

property Success: Boolean read;

 

Boolean Success { get; }

 

var Success: Boolean { get{} }

 

Boolean Success { __get; }

 

ReadOnly Property Success() As Boolean

 

Dispose .NET, .NET Standard 2.0, Island, ToffeeV2

Dispose this class and resources attached to it.

 

method Dispose

 

void Dispose()

 

func Dispose()

 

Sub Dispose()

GetContentAsBinary

Returns the response as binary.

 

method GetContentAsBinary(contentCallback: not nullable HttpContentResponseBlock<ImmutableBinary>)

 

void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary>! contentCallback)

 

func GetContentAsBinary(_ contentCallback: HttpContentResponseBlock<ImmutableBinary>)

 

void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary> contentCallback)

 

Sub GetContentAsBinary(contentCallback As HttpContentResponseBlock<ImmutableBinary>)

Parameters:

  • contentCallback:

GetContentAsBinarySynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Returns the response as binary.

 

method GetContentAsBinarySynchronous: not nullable ImmutableBinary

 

ImmutableBinary! GetContentAsBinarySynchronous()

 

func GetContentAsBinarySynchronous() -> ImmutableBinary

 

ImmutableBinary GetContentAsBinarySynchronous()

 

Function GetContentAsBinarySynchronous() As ImmutableBinary

GetContentAsBinarySynchronous GetContentAsBinarySynchronous(): not nullable ImmutableBinary  virtual Toffee

 

func GetContentAsBinarySynchronous(GetContentAsBinarySynchronous ) -> ImmutableBinary

Parameters:

  • :

GetContentAsJson

Returns the response as json.

 

method GetContentAsJson(contentCallback: not nullable HttpContentResponseBlock<JsonDocument>)

 

void GetContentAsJson(HttpContentResponseBlock<JsonDocument>! contentCallback)

 

func GetContentAsJson(_ contentCallback: HttpContentResponseBlock<JsonDocument>)

 

void GetContentAsJson(HttpContentResponseBlock<JsonDocument> contentCallback)

 

Sub GetContentAsJson(contentCallback As HttpContentResponseBlock<JsonDocument>)

Parameters:

  • contentCallback:

GetContentAsJsonSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Returns the response as json.

 

method GetContentAsJsonSynchronous: not nullable JsonDocument

 

JsonDocument! GetContentAsJsonSynchronous()

 

func GetContentAsJsonSynchronous() -> JsonDocument

 

JsonDocument GetContentAsJsonSynchronous()

 

Function GetContentAsJsonSynchronous() As JsonDocument

GetContentAsJsonSynchronous GetContentAsJsonSynchronous(): not nullable JsonDocument  virtual Toffee

 

func GetContentAsJsonSynchronous(GetContentAsJsonSynchronous ) -> JsonDocument

Parameters:

  • :

GetContentAsString

Returns the response as string.

 

method GetContentAsString(aEncoding: Encoding; contentCallback: not nullable HttpContentResponseBlock<String>)

 

void GetContentAsString(Encoding aEncoding, HttpContentResponseBlock<String>! contentCallback)

 

func GetContentAsString(_ aEncoding: Encoding, _ contentCallback: HttpContentResponseBlock<String>)

 

void GetContentAsString(Encoding aEncoding, HttpContentResponseBlock<String> contentCallback)

 

Sub GetContentAsString(aEncoding As Encoding, contentCallback As HttpContentResponseBlock<String>)

Parameters:

  • aEncoding:
  • contentCallback:

GetContentAsStringSynchronous

Returns the response as string.

 

method GetContentAsStringSynchronous(aEncoding: Encoding): not nullable String

 

String! GetContentAsStringSynchronous(Encoding aEncoding)

 

func GetContentAsStringSynchronous(_ aEncoding: Encoding) -> String

 

String GetContentAsStringSynchronous(Encoding aEncoding)

 

Function GetContentAsStringSynchronous(aEncoding As Encoding) As String

Parameters:

  • aEncoding:

GetContentAsXml

Returns the response as xml.

 

method GetContentAsXml(contentCallback: not nullable HttpContentResponseBlock<XmlDocument>)

 

void GetContentAsXml(HttpContentResponseBlock<XmlDocument>! contentCallback)

 

func GetContentAsXml(_ contentCallback: HttpContentResponseBlock<XmlDocument>)

 

void GetContentAsXml(HttpContentResponseBlock<XmlDocument> contentCallback)

 

Sub GetContentAsXml(contentCallback As HttpContentResponseBlock<XmlDocument>)

Parameters:

  • contentCallback:

GetContentAsXmlSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Returns the response as xml.

 

method GetContentAsXmlSynchronous: not nullable XmlDocument

 

XmlDocument! GetContentAsXmlSynchronous()

 

func GetContentAsXmlSynchronous() -> XmlDocument

 

XmlDocument GetContentAsXmlSynchronous()

 

Function GetContentAsXmlSynchronous() As XmlDocument

GetContentAsXmlSynchronous GetContentAsXmlSynchronous(): not nullable XmlDocument  virtual Toffee

 

func GetContentAsXmlSynchronous(GetContentAsXmlSynchronous ) -> XmlDocument

Parameters:

  • :

SaveContentAsFile

 

method SaveContentAsFile(aTargetFile: not nullable String; contentCallback: not nullable HttpContentResponseBlock<File>)

 

void SaveContentAsFile(String! aTargetFile, HttpContentResponseBlock<File>! contentCallback)

 

func SaveContentAsFile(_ aTargetFile: String, _ contentCallback: HttpContentResponseBlock<File>)

 

void SaveContentAsFile(String aTargetFile, HttpContentResponseBlock<File> contentCallback)

 

Sub SaveContentAsFile(aTargetFile As String, contentCallback As HttpContentResponseBlock<File>)

Parameters:

  • aTargetFile:
  • contentCallback:

SaveContentAsFileSynchronous

Save the response content to a file.

 

method SaveContentAsFileSynchronous(aTargetFile: File)

 

void SaveContentAsFileSynchronous(File aTargetFile)

 

func SaveContentAsFileSynchronous(_ aTargetFile: File)

 

void SaveContentAsFileSynchronous(File aTargetFile)

 

Sub SaveContentAsFileSynchronous(aTargetFile As File)

Parameters:

  • aTargetFile:

TryGetContentAsJsonSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Gets the content as json, returning null for failure.

 

method TryGetContentAsJsonSynchronous: nullable JsonDocument

 

JsonDocument? TryGetContentAsJsonSynchronous()

 

func TryGetContentAsJsonSynchronous() -> JsonDocument?

 

JsonDocument TryGetContentAsJsonSynchronous()

 

Function TryGetContentAsJsonSynchronous() As JsonDocument?

TryGetContentAsJsonSynchronous TryGetContentAsJsonSynchronous(): JsonDocument  virtual Toffee

 

func TryGetContentAsJsonSynchronous(TryGetContentAsJsonSynchronous ) -> JsonDocument

Parameters:

  • :

TryGetContentAsXmlSynchronous .NET, .NET Standard 2.0, Cooper, Island, ToffeeV2

Gets the content as xml, returning null for failure.

 

method TryGetContentAsXmlSynchronous: nullable XmlDocument

 

XmlDocument? TryGetContentAsXmlSynchronous()

 

func TryGetContentAsXmlSynchronous() -> XmlDocument?

 

XmlDocument TryGetContentAsXmlSynchronous()

 

Function TryGetContentAsXmlSynchronous() As XmlDocument?

TryGetContentAsXmlSynchronous TryGetContentAsXmlSynchronous(): XmlDocument  virtual Toffee

 

func TryGetContentAsXmlSynchronous(TryGetContentAsXmlSynchronous ) -> XmlDocument

Parameters:

  • :

 

Implements