Home Original page

HttpResponse

Code

property Code: Int32 read write;
var Code: Int32 { get{} set{} }
Integer Code { __get; __set; }

ContentEncoding

property ContentEncoding: nullable String read;
String? ContentEncoding { get; }
// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var ContentEncoding: String? { get{} }
// Toffee
var ContentEncoding: String { get{} }
String ContentEncoding { __get; }
ReadOnly Property ContentEncoding() As String?

ContentType

property ContentType: nullable String read;
String? ContentType { get; }
// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var ContentType: String? { get{} }
// Toffee
var ContentType: String { get{} }
String ContentType { __get; }
ReadOnly Property ContentType() As String?

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

Dispose this class and resources attached to it.

Exception

Exception retrieving this request.

property Exception: nullable Exception read write;
Exception? Exception { get; set; }
// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var Exception: Exception? { get{} set{} }
// Toffee
var Exception: Exception { get{} set{} }
Exception Exception { __get; __set; }
Property Exception() As Exception?

GetContentAsBinary

Returns the response as string.

method GetContentAsBinary(aContentCallback: not nullable HttpContentResponseBlock<ImmutableBinary>)
void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary>! aContentCallback)
func GetContentAsBinary(_ aContentCallback: HttpContentResponseBlock<ImmutableBinary>)
void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary> aContentCallback)
Sub GetContentAsBinary(aContentCallback As HttpContentResponseBlock<ImmutableBinary>)

Parameters:

  • aContentCallback:

GetContentAsBinarySynchronous

Returns the response as binary.

method GetContentAsBinarySynchronous: not nullable ImmutableBinary
ImmutableBinary! GetContentAsBinarySynchronous()
func GetContentAsBinarySynchronous() -> ImmutableBinary
ImmutableBinary GetContentAsBinarySynchronous()
Function GetContentAsBinarySynchronous() As ImmutableBinary

GetContentAsJson

Returns the response as string.

method GetContentAsJson(aContentCallback: not nullable HttpContentResponseBlock<JsonDocument>)
void GetContentAsJson(HttpContentResponseBlock<JsonDocument>! aContentCallback)
func GetContentAsJson(_ aContentCallback: HttpContentResponseBlock<JsonDocument>)
void GetContentAsJson(HttpContentResponseBlock<JsonDocument> aContentCallback)
Sub GetContentAsJson(aContentCallback As HttpContentResponseBlock<JsonDocument>)

Parameters:

  • aContentCallback:

GetContentAsJsonSynchronous

Returns the response as json.

method GetContentAsJsonSynchronous: not nullable JsonDocument
JsonDocument! GetContentAsJsonSynchronous()
func GetContentAsJsonSynchronous() -> JsonDocument
JsonDocument GetContentAsJsonSynchronous()
Function GetContentAsJsonSynchronous() As JsonDocument

GetContentAsLines

method GetContentAsLines(aEncoding: Encoding := nil; aContentCallback: not nullable HttpStringStreamResponseBlock<String>)
void GetContentAsLines(Encoding aEncoding = null, HttpStringStreamResponseBlock<String>! aContentCallback)
func GetContentAsLines(_ aEncoding: Encoding = nil, _ aContentCallback: HttpStringStreamResponseBlock<String>)
void GetContentAsLines(Encoding aEncoding, HttpStringStreamResponseBlock<String> aContentCallback)
Sub GetContentAsLines(aEncoding As Encoding = Null, aContentCallback As HttpStringStreamResponseBlock<String>)

Parameters:

  • aEncoding:
  • aContentCallback:

GetContentAsStreamedBinary

method GetContentAsStreamedBinary(aContentCallback: not nullable HttpStringStreamResponseBlock<ImmutableBinary>)
void GetContentAsStreamedBinary(HttpStringStreamResponseBlock<ImmutableBinary>! aContentCallback)
func GetContentAsStreamedBinary(_ aContentCallback: HttpStringStreamResponseBlock<ImmutableBinary>)
void GetContentAsStreamedBinary(HttpStringStreamResponseBlock<ImmutableBinary> aContentCallback)
Sub GetContentAsStreamedBinary(aContentCallback As HttpStringStreamResponseBlock<ImmutableBinary>)

Parameters:

  • aContentCallback:

GetContentAsStreamedString

method GetContentAsStreamedString(aEncoding: Encoding := nil; aContentCallback: not nullable HttpStringStreamResponseBlock<String>)
void GetContentAsStreamedString(Encoding aEncoding = null, HttpStringStreamResponseBlock<String>! aContentCallback)
func GetContentAsStreamedString(_ aEncoding: Encoding = nil, _ aContentCallback: HttpStringStreamResponseBlock<String>)
void GetContentAsStreamedString(Encoding aEncoding, HttpStringStreamResponseBlock<String> aContentCallback)
Sub GetContentAsStreamedString(aEncoding As Encoding = Null, aContentCallback As HttpStringStreamResponseBlock<String>)

Parameters:

  • aEncoding:
  • aContentCallback:

GetContentAsString

Returns the response as string.

method GetContentAsString(aEncoding: Encoding := nil; aContentCallback: not nullable HttpContentResponseBlock<String>)
void GetContentAsString(Encoding aEncoding = null, HttpContentResponseBlock<String>! aContentCallback)
func GetContentAsString(_ aEncoding: Encoding = nil, _ aContentCallback: HttpContentResponseBlock<String>)
void GetContentAsString(Encoding aEncoding, HttpContentResponseBlock<String> aContentCallback)
Sub GetContentAsString(aEncoding As Encoding = Null, aContentCallback As HttpContentResponseBlock<String>)

Parameters:

  • aEncoding:
  • aContentCallback:

GetContentAsStringSynchronous

Returns the response as string.

method GetContentAsStringSynchronous(aEncoding: Encoding := nil): not nullable String
String! GetContentAsStringSynchronous(Encoding aEncoding = null)
func GetContentAsStringSynchronous(_ aEncoding: Encoding = nil) -> String
String GetContentAsStringSynchronous(Encoding aEncoding)
Function GetContentAsStringSynchronous(aEncoding As Encoding = Null) As String

Parameters:

  • aEncoding:

GetContentAsXml

Returns the response as string.

method GetContentAsXml(aContentCallback: not nullable HttpContentResponseBlock<XmlDocument>)
void GetContentAsXml(HttpContentResponseBlock<XmlDocument>! aContentCallback)
func GetContentAsXml(_ aContentCallback: HttpContentResponseBlock<XmlDocument>)
void GetContentAsXml(HttpContentResponseBlock<XmlDocument> aContentCallback)
Sub GetContentAsXml(aContentCallback As HttpContentResponseBlock<XmlDocument>)

Parameters:

  • aContentCallback:

GetContentAsXmlSynchronous

Returns the response as xml.

method GetContentAsXmlSynchronous: not nullable XmlDocument
XmlDocument! GetContentAsXmlSynchronous()
func GetContentAsXmlSynchronous() -> XmlDocument
XmlDocument GetContentAsXmlSynchronous()
Function GetContentAsXmlSynchronous() As XmlDocument
property Headers: not nullable ImmutableDictionary<String, String> read write;
ImmutableDictionary<String, String>! Headers { get; set; }
var Headers: ImmutableDictionary<String, String> { get{} set{} }
ImmutableDictionary<String, String> Headers { __get; __set; }
Property Headers() As ImmutableDictionary<String, String>

SaveContentAsFile

method SaveContentAsFile(aTargetFile: not nullable String; aContentCallback: not nullable HttpContentResponseBlock<File>)
void SaveContentAsFile(String! aTargetFile, HttpContentResponseBlock<File>! aContentCallback)
func SaveContentAsFile(_ aTargetFile: String, _ aContentCallback: HttpContentResponseBlock<File>)
void SaveContentAsFile(String aTargetFile, HttpContentResponseBlock<File> aContentCallback)
Sub SaveContentAsFile(aTargetFile As String, aContentCallback As HttpContentResponseBlock<File>)

Parameters:

  • aTargetFile:
  • aContentCallback:

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;
var Success: Boolean { get{} }
Boolean Success { __get; }
ReadOnly Property Success() As Boolean

TryGetContentAsBinarySynchronous

method TryGetContentAsBinarySynchronous: nullable ImmutableBinary
ImmutableBinary? TryGetContentAsBinarySynchronous()
// Toffee
func TryGetContentAsBinarySynchronous() -> ImmutableBinary
// ToffeeV2
func TryGetContentAsBinarySynchronous() -> ImmutableBinary?
ImmutableBinary TryGetContentAsBinarySynchronous()
Function TryGetContentAsBinarySynchronous() As ImmutableBinary?

TryGetContentAsJsonSynchronous

Gets the content as json, returning null for failure.

method TryGetContentAsJsonSynchronous: nullable JsonDocument
JsonDocument? TryGetContentAsJsonSynchronous()
// Toffee
func TryGetContentAsJsonSynchronous() -> JsonDocument
// ToffeeV2
func TryGetContentAsJsonSynchronous() -> JsonDocument?
JsonDocument TryGetContentAsJsonSynchronous()
Function TryGetContentAsJsonSynchronous() As JsonDocument?

TryGetContentAsXmlSynchronous

Gets the content as xml, returning null for failure.

method TryGetContentAsXmlSynchronous: nullable XmlDocument
XmlDocument? TryGetContentAsXmlSynchronous()
// Toffee
func TryGetContentAsXmlSynchronous() -> XmlDocument
// ToffeeV2
func TryGetContentAsXmlSynchronous() -> XmlDocument?
XmlDocument TryGetContentAsXmlSynchronous()
Function TryGetContentAsXmlSynchronous() As XmlDocument?

URLSession (NSURLSession) dataTask(NSURLSessionDataTask) didReceiveData(NSData) Toffee, ToffeeV2

func URLSession(_ session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveData aData: NSData)

Parameters:

  • session:
  • dataTask:
  • aData:

URLSession (NSURLSession) dataTask(NSURLSessionDataTask) didReceiveResponse(NSURLResponse) completionHandler(block(NSURLSessionResponseDisposition)) Toffee, ToffeeV2

func URLSession(_ session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveResponse aResponse: NSURLResponse, completionHandler: (NSURLSessionResponseDisposition) -> ())

Parameters:

  • session:
  • dataTask:
  • aResponse:
  • completionHandler:

URLSession (NSURLSession) didReceiveChallenge(NSURLAuthenticationChallenge) completionHandler(block(NSURLSessionAuthChallengeDisposition, NSURLCredential)) Toffee, ToffeeV2

func URLSession(_ session: NSURLSession, didReceiveChallenge challenge: NSURLAuthenticationChallenge, completionHandler: (NSURLSessionAuthChallengeDisposition, NSURLCredential) -> ())

Parameters:

  • session:
  • challenge:
  • completionHandler:

URLSession (NSURLSession) task(NSURLSessionTask) didCompleteWithError(NSError) Toffee, ToffeeV2

// Toffee
func URLSession(_ session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError)
// ToffeeV2
func URLSession(_ session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError?)

Parameters:

  • session:
  • task:
  • error:

Code

property Code: Int32 read write;
var Code: Int32 { get{} set{} }
Integer Code { __get; __set; }

ContentEncoding

property ContentEncoding: nullable String read;
String? ContentEncoding { get; }
// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var ContentEncoding: String? { get{} }
// Toffee
var ContentEncoding: String { get{} }
String ContentEncoding { __get; }
ReadOnly Property ContentEncoding() As String?

ContentType

property ContentType: nullable String read;
String? ContentType { get; }
// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var ContentType: String? { get{} }
// Toffee
var ContentType: String { get{} }
String ContentType { __get; }
ReadOnly Property ContentType() As String?

Exception

Exception retrieving this request.

property Exception: nullable Exception read write;
Exception? Exception { get; set; }
// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var Exception: Exception? { get{} set{} }
// Toffee
var Exception: Exception { get{} set{} }
Exception Exception { __get; __set; }
Property Exception() As Exception?
property Headers: not nullable ImmutableDictionary<String, String> read write;
ImmutableDictionary<String, String>! Headers { get; set; }
var Headers: ImmutableDictionary<String, String> { get{} set{} }
ImmutableDictionary<String, String> Headers { __get; __set; }
Property Headers() As ImmutableDictionary<String, String>

Success

True if this response is a success response.

property Success: Boolean read;
var Success: Boolean { get{} }
Boolean Success { __get; }
ReadOnly Property Success() As Boolean

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

Dispose this class and resources attached to it.

GetContentAsBinary

Returns the response as string.

method GetContentAsBinary(aContentCallback: not nullable HttpContentResponseBlock<ImmutableBinary>)
void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary>! aContentCallback)
func GetContentAsBinary(_ aContentCallback: HttpContentResponseBlock<ImmutableBinary>)
void GetContentAsBinary(HttpContentResponseBlock<ImmutableBinary> aContentCallback)
Sub GetContentAsBinary(aContentCallback As HttpContentResponseBlock<ImmutableBinary>)

Parameters:

  • aContentCallback:

GetContentAsBinarySynchronous

Returns the response as binary.

method GetContentAsBinarySynchronous: not nullable ImmutableBinary
ImmutableBinary! GetContentAsBinarySynchronous()
func GetContentAsBinarySynchronous() -> ImmutableBinary
ImmutableBinary GetContentAsBinarySynchronous()
Function GetContentAsBinarySynchronous() As ImmutableBinary

GetContentAsJson

Returns the response as string.

method GetContentAsJson(aContentCallback: not nullable HttpContentResponseBlock<JsonDocument>)
void GetContentAsJson(HttpContentResponseBlock<JsonDocument>! aContentCallback)
func GetContentAsJson(_ aContentCallback: HttpContentResponseBlock<JsonDocument>)
void GetContentAsJson(HttpContentResponseBlock<JsonDocument> aContentCallback)
Sub GetContentAsJson(aContentCallback As HttpContentResponseBlock<JsonDocument>)

Parameters:

  • aContentCallback:

GetContentAsJsonSynchronous

Returns the response as json.

method GetContentAsJsonSynchronous: not nullable JsonDocument
JsonDocument! GetContentAsJsonSynchronous()
func GetContentAsJsonSynchronous() -> JsonDocument
JsonDocument GetContentAsJsonSynchronous()
Function GetContentAsJsonSynchronous() As JsonDocument

GetContentAsLines

method GetContentAsLines(aEncoding: Encoding := nil; aContentCallback: not nullable HttpStringStreamResponseBlock<String>)
void GetContentAsLines(Encoding aEncoding = null, HttpStringStreamResponseBlock<String>! aContentCallback)
func GetContentAsLines(_ aEncoding: Encoding = nil, _ aContentCallback: HttpStringStreamResponseBlock<String>)
void GetContentAsLines(Encoding aEncoding, HttpStringStreamResponseBlock<String> aContentCallback)
Sub GetContentAsLines(aEncoding As Encoding = Null, aContentCallback As HttpStringStreamResponseBlock<String>)

Parameters:

  • aEncoding:
  • aContentCallback:

GetContentAsStreamedBinary

method GetContentAsStreamedBinary(aContentCallback: not nullable HttpStringStreamResponseBlock<ImmutableBinary>)
void GetContentAsStreamedBinary(HttpStringStreamResponseBlock<ImmutableBinary>! aContentCallback)
func GetContentAsStreamedBinary(_ aContentCallback: HttpStringStreamResponseBlock<ImmutableBinary>)
void GetContentAsStreamedBinary(HttpStringStreamResponseBlock<ImmutableBinary> aContentCallback)
Sub GetContentAsStreamedBinary(aContentCallback As HttpStringStreamResponseBlock<ImmutableBinary>)

Parameters:

  • aContentCallback:

GetContentAsStreamedString

method GetContentAsStreamedString(aEncoding: Encoding := nil; aContentCallback: not nullable HttpStringStreamResponseBlock<String>)
void GetContentAsStreamedString(Encoding aEncoding = null, HttpStringStreamResponseBlock<String>! aContentCallback)
func GetContentAsStreamedString(_ aEncoding: Encoding = nil, _ aContentCallback: HttpStringStreamResponseBlock<String>)
void GetContentAsStreamedString(Encoding aEncoding, HttpStringStreamResponseBlock<String> aContentCallback)
Sub GetContentAsStreamedString(aEncoding As Encoding = Null, aContentCallback As HttpStringStreamResponseBlock<String>)

Parameters:

  • aEncoding:
  • aContentCallback:

GetContentAsString

Returns the response as string.

method GetContentAsString(aEncoding: Encoding := nil; aContentCallback: not nullable HttpContentResponseBlock<String>)
void GetContentAsString(Encoding aEncoding = null, HttpContentResponseBlock<String>! aContentCallback)
func GetContentAsString(_ aEncoding: Encoding = nil, _ aContentCallback: HttpContentResponseBlock<String>)
void GetContentAsString(Encoding aEncoding, HttpContentResponseBlock<String> aContentCallback)
Sub GetContentAsString(aEncoding As Encoding = Null, aContentCallback As HttpContentResponseBlock<String>)

Parameters:

  • aEncoding:
  • aContentCallback:

GetContentAsStringSynchronous

Returns the response as string.

method GetContentAsStringSynchronous(aEncoding: Encoding := nil): not nullable String
String! GetContentAsStringSynchronous(Encoding aEncoding = null)
func GetContentAsStringSynchronous(_ aEncoding: Encoding = nil) -> String
String GetContentAsStringSynchronous(Encoding aEncoding)
Function GetContentAsStringSynchronous(aEncoding As Encoding = Null) As String

Parameters:

  • aEncoding:

GetContentAsXml

Returns the response as string.

method GetContentAsXml(aContentCallback: not nullable HttpContentResponseBlock<XmlDocument>)
void GetContentAsXml(HttpContentResponseBlock<XmlDocument>! aContentCallback)
func GetContentAsXml(_ aContentCallback: HttpContentResponseBlock<XmlDocument>)
void GetContentAsXml(HttpContentResponseBlock<XmlDocument> aContentCallback)
Sub GetContentAsXml(aContentCallback As HttpContentResponseBlock<XmlDocument>)

Parameters:

  • aContentCallback:

GetContentAsXmlSynchronous

Returns the response as xml.

method GetContentAsXmlSynchronous: not nullable XmlDocument
XmlDocument! GetContentAsXmlSynchronous()
func GetContentAsXmlSynchronous() -> XmlDocument
XmlDocument GetContentAsXmlSynchronous()
Function GetContentAsXmlSynchronous() As XmlDocument

SaveContentAsFile

method SaveContentAsFile(aTargetFile: not nullable String; aContentCallback: not nullable HttpContentResponseBlock<File>)
void SaveContentAsFile(String! aTargetFile, HttpContentResponseBlock<File>! aContentCallback)
func SaveContentAsFile(_ aTargetFile: String, _ aContentCallback: HttpContentResponseBlock<File>)
void SaveContentAsFile(String aTargetFile, HttpContentResponseBlock<File> aContentCallback)
Sub SaveContentAsFile(aTargetFile As String, aContentCallback As HttpContentResponseBlock<File>)

Parameters:

  • aTargetFile:
  • aContentCallback:

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:

TryGetContentAsBinarySynchronous

method TryGetContentAsBinarySynchronous: nullable ImmutableBinary
ImmutableBinary? TryGetContentAsBinarySynchronous()
// Toffee
func TryGetContentAsBinarySynchronous() -> ImmutableBinary
// ToffeeV2
func TryGetContentAsBinarySynchronous() -> ImmutableBinary?
ImmutableBinary TryGetContentAsBinarySynchronous()
Function TryGetContentAsBinarySynchronous() As ImmutableBinary?

TryGetContentAsJsonSynchronous

Gets the content as json, returning null for failure.

method TryGetContentAsJsonSynchronous: nullable JsonDocument
JsonDocument? TryGetContentAsJsonSynchronous()
// Toffee
func TryGetContentAsJsonSynchronous() -> JsonDocument
// ToffeeV2
func TryGetContentAsJsonSynchronous() -> JsonDocument?
JsonDocument TryGetContentAsJsonSynchronous()
Function TryGetContentAsJsonSynchronous() As JsonDocument?

TryGetContentAsXmlSynchronous

Gets the content as xml, returning null for failure.

method TryGetContentAsXmlSynchronous: nullable XmlDocument
XmlDocument? TryGetContentAsXmlSynchronous()
// Toffee
func TryGetContentAsXmlSynchronous() -> XmlDocument
// ToffeeV2
func TryGetContentAsXmlSynchronous() -> XmlDocument?
XmlDocument TryGetContentAsXmlSynchronous()
Function TryGetContentAsXmlSynchronous() As XmlDocument?

URLSession (NSURLSession) dataTask(NSURLSessionDataTask) didReceiveData(NSData) Toffee, ToffeeV2

func URLSession(_ session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveData aData: NSData)

Parameters:

  • session:
  • dataTask:
  • aData:

URLSession (NSURLSession) dataTask(NSURLSessionDataTask) didReceiveResponse(NSURLResponse) completionHandler(block(NSURLSessionResponseDisposition)) Toffee, ToffeeV2

func URLSession(_ session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveResponse aResponse: NSURLResponse, completionHandler: (NSURLSessionResponseDisposition) -> ())

Parameters:

  • session:
  • dataTask:
  • aResponse:
  • completionHandler:

URLSession (NSURLSession) didReceiveChallenge(NSURLAuthenticationChallenge) completionHandler(block(NSURLSessionAuthChallengeDisposition, NSURLCredential)) Toffee, ToffeeV2

func URLSession(_ session: NSURLSession, didReceiveChallenge challenge: NSURLAuthenticationChallenge, completionHandler: (NSURLSessionAuthChallengeDisposition, NSURLCredential) -> ())

Parameters:

  • session:
  • challenge:
  • completionHandler:

URLSession (NSURLSession) task(NSURLSessionTask) didCompleteWithError(NSError) Toffee, ToffeeV2

// Toffee
func URLSession(_ session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError)
// ToffeeV2
func URLSession(_ session: NSURLSession, task: NSURLSessionTask, didCompleteWithError error: NSError?)

Parameters:

  • session:
  • task:
  • error: