ApiResult
Overview
Location
- Reference: RemObjects.SDK.dll
- Namespace: RemObjects.SDK.Types
- Ancestry: MemoryStream | Binary | ApiResult
constructor (declared in Binary)
constructor
ApiResult()
Sub New()
constructor (array of Byte) (declared in Binary)
constructor(buffer: array of Byte)
ApiResult(Byte[] buffer)
Sub New(buffer As Byte())
Parameters:
- buffer:
constructor (String) (declared in Binary)
constructor(buffer: String)
ApiResult(String buffer)
Sub New(buffer As String)
Parameters:
- buffer:
constructor (String, String)
constructor(contentType: String; content: String)
ApiResult(String contentType, String content)
Sub New(contentType As String, content As String)
Parameters:
- contentType:
- content:
constructor (String, array of Byte)
constructor(contentType: String; contentBytes: array of Byte)
ApiResult(String contentType, Byte[] contentBytes)
Sub New(contentType As String, contentBytes As Byte())
Parameters:
- contentType:
- contentBytes:
constructor (HttpStatusCode, String, String)
constructor(statusCode: HttpStatusCode; contentType: String; content: String)
ApiResult(HttpStatusCode statusCode, String contentType, String content)
Sub New(statusCode As HttpStatusCode, contentType As String, content As String)
Parameters:
- statusCode:
- contentType:
- content:
constructor (HttpStatusCode, String, array of Byte)
constructor(statusCode: HttpStatusCode; contentType: String; contentBytes: array of Byte)
ApiResult(HttpStatusCode statusCode, String contentType, Byte[] contentBytes)
Sub New(statusCode As HttpStatusCode, contentType As String, contentBytes As Byte())
Parameters:
- statusCode:
- contentType:
- contentBytes:
constructor (HttpStatusCode, String, String, Boolean, array of Byte)
constructor(statusCode: HttpStatusCode; contentType: String; filename: String; isInline: Boolean; contentBytes: array of Byte)
ApiResult(HttpStatusCode statusCode, String contentType, String filename, Boolean isInline, Byte[] contentBytes)
Sub New(statusCode As HttpStatusCode, contentType As String, filename As String, isInline As Boolean, contentBytes As Byte())
Parameters:
- statusCode:
- contentType:
- filename:
- isInline:
- contentBytes:
ContentDisposition
property ContentDisposition: String read;
String ContentDisposition { get; }
ReadOnly Property ContentDisposition() As String
ContentFileName
property ContentFileName: String read write;
String ContentFileName { get; set; }
Property ContentFileName() As String
ContentIsInline
property ContentIsInline: Boolean read write;
Boolean ContentIsInline { get; set; }
Property ContentIsInline() As Boolean
ContentType
property ContentType: String read;
String ContentType { get; }
ReadOnly Property ContentType() As String
HttpStatusCode
property HttpStatusCode: HttpStatusCode read;
HttpStatusCode HttpStatusCode { get; }
ReadOnly Property HttpStatusCode() As HttpStatusCode
LoadFromStream (Stream) (declared in Binary)
Loads the Binary by reading data from the given stream. The Position of the Binary will be reset before the load and the entire data in the Binary will be replaced with the data from the passed stream.
method LoadFromStream(stream: Stream)
void LoadFromStream(Stream stream)
Sub LoadFromStream(stream As Stream)
Parameters:
- stream:
LoadFromStream (Stream, Int32) (declared in Binary)
method LoadFromStream(stream: Stream; count: Int32)
void LoadFromStream(Stream stream, Int32 count)
Sub LoadFromStream(stream As Stream, count As Int32)
Parameters:
- stream:
- count:
LoadFromString (String) (declared in Binary)
Uses aValue
to load the stream from a string by converting it to a byte array before writing it to the stream using thr provided encoding aEncoding
.
This method is overloaded. An overloaded method has no aEncoding
parameter and used ASCII by default.
The string representation of the Binary can be accessed via the ToString() method.
method LoadFromString(value: String)
void LoadFromString(String value)
Sub LoadFromString(value As String)
Parameters:
- value:
LoadFromString (String, Encoding) (declared in Binary)
method LoadFromString(value: String; encoding: Encoding)
void LoadFromString(String value, Encoding encoding)
Sub LoadFromString(value As String, encoding As Encoding)
Parameters:
- value:
- encoding:
Read (declared in Binary)
Reads a block of bytes from the current stream and writes the data to the buffer. Returns the really read count of bytes.
method Read(buffer: array of Byte; count: Int32): Int32
Int32 Read(Byte[] buffer, Int32 count)
Function Read(buffer As Byte(), count As Int32) As Int32
Parameters:
- buffer:
- count:
ReadFromStream (Stream) (declared in Binary)
Reads all the binary data from another aStream
stream with the CopyFromStreamToStream method of StreamHelpers class.
method ReadFromStream(stream: Stream)
void ReadFromStream(Stream stream)
Sub ReadFromStream(stream As Stream)
Parameters:
- stream:
ReadFromStream (Stream, Int32) (declared in Binary)
Reads a maximum of aCount bytes from aStream.
method ReadFromStream(stream: Stream; count: Int32)
void ReadFromStream(Stream stream, Int32 count)
Sub ReadFromStream(stream As Stream, count As Int32)
Parameters:
- stream:
- count:
SaveToStream (declared in Binary)
Saves the entire data from the Binary to the given aStream
stream.
method SaveToStream(stream: Stream)
void SaveToStream(Stream stream)
Sub SaveToStream(stream As Stream)
Parameters:
- stream:
ToString (declared in Binary)
Overrides Object.ToString() to return a string representation of the stream. This conversion is done using the StreamToString() method in the StreamHelpers. A Binary instance can be loaded from a string using the LoadFromString() method or via the overloaded constructor.
method ToString: String
String ToString()
Function ToString() As String
Write (declared in Binary)
Writes a block of bytes to the current stream using data read from the buffer.
method Write(buffer: array of Byte; count: Int32)
void Write(Byte[] buffer, Int32 count)
Sub Write(buffer As Byte(), count As Int32)
Parameters:
- buffer:
- count:
ContentDisposition
property ContentDisposition: String read;
String ContentDisposition { get; }
ReadOnly Property ContentDisposition() As String
ContentFileName
property ContentFileName: String read write;
String ContentFileName { get; set; }
Property ContentFileName() As String
ContentIsInline
property ContentIsInline: Boolean read write;
Boolean ContentIsInline { get; set; }
Property ContentIsInline() As Boolean
ContentType
property ContentType: String read;
String ContentType { get; }
ReadOnly Property ContentType() As String
HttpStatusCode
property HttpStatusCode: HttpStatusCode read;
HttpStatusCode HttpStatusCode { get; }
ReadOnly Property HttpStatusCode() As HttpStatusCode
constructor (declared in Binary)
constructor
ApiResult()
Sub New()
constructor (array of Byte) (declared in Binary)
constructor(buffer: array of Byte)
ApiResult(Byte[] buffer)
Sub New(buffer As Byte())
Parameters:
- buffer:
constructor (String) (declared in Binary)
constructor(buffer: String)
ApiResult(String buffer)
Sub New(buffer As String)
Parameters:
- buffer:
constructor (String, String)
constructor(contentType: String; content: String)
ApiResult(String contentType, String content)
Sub New(contentType As String, content As String)
Parameters:
- contentType:
- content:
constructor (String, array of Byte)
constructor(contentType: String; contentBytes: array of Byte)
ApiResult(String contentType, Byte[] contentBytes)
Sub New(contentType As String, contentBytes As Byte())
Parameters:
- contentType:
- contentBytes:
constructor (HttpStatusCode, String, String)
constructor(statusCode: HttpStatusCode; contentType: String; content: String)
ApiResult(HttpStatusCode statusCode, String contentType, String content)
Sub New(statusCode As HttpStatusCode, contentType As String, content As String)
Parameters:
- statusCode:
- contentType:
- content:
constructor (HttpStatusCode, String, array of Byte)
constructor(statusCode: HttpStatusCode; contentType: String; contentBytes: array of Byte)
ApiResult(HttpStatusCode statusCode, String contentType, Byte[] contentBytes)
Sub New(statusCode As HttpStatusCode, contentType As String, contentBytes As Byte())
Parameters:
- statusCode:
- contentType:
- contentBytes:
constructor (HttpStatusCode, String, String, Boolean, array of Byte)
constructor(statusCode: HttpStatusCode; contentType: String; filename: String; isInline: Boolean; contentBytes: array of Byte)
ApiResult(HttpStatusCode statusCode, String contentType, String filename, Boolean isInline, Byte[] contentBytes)
Sub New(statusCode As HttpStatusCode, contentType As String, filename As String, isInline As Boolean, contentBytes As Byte())
Parameters:
- statusCode:
- contentType:
- filename:
- isInline:
- contentBytes:
LoadFromStream (Stream) (declared in Binary)
Loads the Binary by reading data from the given stream. The Position of the Binary will be reset before the load and the entire data in the Binary will be replaced with the data from the passed stream.
method LoadFromStream(stream: Stream)
void LoadFromStream(Stream stream)
Sub LoadFromStream(stream As Stream)
Parameters:
- stream:
LoadFromStream (Stream, Int32) (declared in Binary)
method LoadFromStream(stream: Stream; count: Int32)
void LoadFromStream(Stream stream, Int32 count)
Sub LoadFromStream(stream As Stream, count As Int32)
Parameters:
- stream:
- count:
LoadFromString (String) (declared in Binary)
Uses aValue
to load the stream from a string by converting it to a byte array before writing it to the stream using thr provided encoding aEncoding
.
This method is overloaded. An overloaded method has no aEncoding
parameter and used ASCII by default.
The string representation of the Binary can be accessed via the ToString() method.
method LoadFromString(value: String)
void LoadFromString(String value)
Sub LoadFromString(value As String)
Parameters:
- value:
LoadFromString (String, Encoding) (declared in Binary)
method LoadFromString(value: String; encoding: Encoding)
void LoadFromString(String value, Encoding encoding)
Sub LoadFromString(value As String, encoding As Encoding)
Parameters:
- value:
- encoding:
Read (declared in Binary)
Reads a block of bytes from the current stream and writes the data to the buffer. Returns the really read count of bytes.
method Read(buffer: array of Byte; count: Int32): Int32
Int32 Read(Byte[] buffer, Int32 count)
Function Read(buffer As Byte(), count As Int32) As Int32
Parameters:
- buffer:
- count:
ReadFromStream (Stream) (declared in Binary)
Reads all the binary data from another aStream
stream with the CopyFromStreamToStream method of StreamHelpers class.
method ReadFromStream(stream: Stream)
void ReadFromStream(Stream stream)
Sub ReadFromStream(stream As Stream)
Parameters:
- stream:
ReadFromStream (Stream, Int32) (declared in Binary)
Reads a maximum of aCount bytes from aStream.
method ReadFromStream(stream: Stream; count: Int32)
void ReadFromStream(Stream stream, Int32 count)
Sub ReadFromStream(stream As Stream, count As Int32)
Parameters:
- stream:
- count:
SaveToStream (declared in Binary)
Saves the entire data from the Binary to the given aStream
stream.
method SaveToStream(stream: Stream)
void SaveToStream(Stream stream)
Sub SaveToStream(stream As Stream)
Parameters:
- stream:
ToString (declared in Binary)
Overrides Object.ToString() to return a string representation of the stream. This conversion is done using the StreamToString() method in the StreamHelpers. A Binary instance can be loaded from a string using the LoadFromString() method or via the overloaded constructor.
method ToString: String
String ToString()
Function ToString() As String
Write (declared in Binary)
Writes a block of bytes to the current stream using data read from the buffer.
method Write(buffer: array of Byte; count: Int32)
void Write(Byte[] buffer, Int32 count)
Sub Write(buffer As Byte(), count As Int32)
Parameters:
- buffer:
- count: