IApiMessage

Overview

Location


 

CanRemapParameters    (declared in IMessage)

 

method CanRemapParameters: Boolean

 

Boolean CanRemapParameters()

 

func CanRemapParameters() -> Boolean

 

Function CanRemapParameters() As Boolean

Clear    (declared in IMessage)

Clear the contents of the message.

 

method Clear

 

void Clear()

 

func Clear()

 

Sub Clear()

ClearAttributes    (declared in IMessage)

Clears internally set serializer options based on the attribute values and/or HTTP headers.

 

method ClearAttributes(channel: IChannel)

 

void ClearAttributes(IChannel channel)

 

func ClearAttributes(_ channel: IChannel)

 

Sub ClearAttributes(channel As IChannel)

Parameters:

  • channel: Communication channel

ClientID    (declared in IMessage)

Provides access to the ClientID read from the message.

 

property ClientID: Guid read write;

 

Guid ClientID { get; set; }

 

var ClientID: Guid { get{} set{} }

 

Property ClientID() As Guid

Clone    (declared in IMessage)

Creates and returns an identical copy of the message.

 

method Clone: IMessage

 

IMessage Clone()

 

func Clone() -> IMessage

 

Function Clone() As IMessage

ContentDisposition

 

property ContentDisposition: String read;

 

String ContentDisposition { get; }

 

var ContentDisposition: String { get{} }

 

ReadOnly Property ContentDisposition() As String

ContentType    (declared in IMessage)

Gets message's content type.

 

property ContentType: String read;

 

String ContentType { get; }

 

var ContentType: String { get{} }

 

ReadOnly Property ContentType() As String

DefaultDispatcherName    (declared in IMessage)

Returns the default/recommended dispatcher name for the message type.

 

property DefaultDispatcherName: String read;

 

String DefaultDispatcherName { get; }

 

var DefaultDispatcherName: String { get{} }

 

ReadOnly Property DefaultDispatcherName() As String

FinalizeMessage    (declared in IMessage)

Should be implemented to ensure that the message content is complete before sending it by doing any final processing necessary.

This method is called after all Parameters have been written to a Message and before the message will be sent. It should perform any necessary wrap-up to ensure that a subsequent call to WriteToStream() will produce a complete message.

 

method FinalizeMessage

 

void FinalizeMessage()

 

func FinalizeMessage()

 

Sub FinalizeMessage()

FinalizeRequest    (declared in IMessage)

Finalizes the data request serialization.

 

method FinalizeRequest(channel: IRequest)

 

void FinalizeRequest(IRequest channel)

 

func FinalizeRequest(_ channel: IRequest)

 

Sub FinalizeRequest(channel As IRequest)

Parameters:

  • channel: Communication channel

GetStream    (declared in IMessage)

Creates a new stream with the content of the message.

 

method GetStream: Stream

 

Stream GetStream()

 

func GetStream() -> Stream

 

Function GetStream() As Stream

HttpStatusCode

 

property HttpStatusCode: Int32 read;

 

Int32 HttpStatusCode { get; }

 

var HttpStatusCode: Int32 { get{} }

 

ReadOnly Property HttpStatusCode() As Int32

InitializeEventMessage (IChannel, String, String)    (declared in IMessage)

This method should be implemented by the Message components to initialize an Event message.

 

method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)

 

func InitializeEventMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)

 

Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel: Communication channel that will be used to send the event message
  • interfaceName: Communication channel that will be used to send the event message
  • messageName: Message name. Corresponds to the name of the service method being executed

InitializeEventMessage (IChannel, String, String, String)    (declared in IMessage)

Initializes new event message for interface interfaceName with message name messageName on channel channel.

 

method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

func InitializeEventMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)

 

Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel: Communication channel that will be used to send the event message
  • libraryName: RODL library name
  • interfaceName: Communication channel that will be used to send the event message
  • messageName: Message name. Corresponds to the name of the service method being executed

InitializeExceptionMessage (IChannel, String, String, Exception)    (declared in IMessage)

Initializes new exception message for interface interfaceName with message name messageName on channel channel.

 

method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; e: Exception)

 

void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception e)

 

func InitializeExceptionMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ e: Exception)

 

Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, e As Exception)

Parameters:

  • channel: Communication channel that will be used to send the exception message
  • interfaceName: A name of the interface (i.e. the service).
  • messageName: Message name. Corresponds to the name of the service method being executed
  • e: Exception that should be serialized and sent to the client application

InitializeExceptionMessage (IChannel, String, String, String, Exception)    (declared in IMessage)

Initializes new exception message for interface interfaceName with message name messageName on channel channel.

 

method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; e: Exception)

 

void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception e)

 

func InitializeExceptionMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ e: Exception)

 

Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, e As Exception)

Parameters:

  • channel: Communication channel that will be used to send the exception message
  • libraryName: RODL library name
  • interfaceName: A name of the interface (i.e. the service).
  • messageName: Message name. Corresponds to the name of the service method being executed
  • e: Exception that should be serialized and sent to the client application

InitializeMessage (IChannel, String, String, MessageType)    (declared in IMessage)

Initializes message of requested type for interface interfaceName with message name messageName on channel channel.

 

method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)

 

func InitializeMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)

 

Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel: Communication channel
  • interfaceName: Interface name
  • messageName: Message name
  • messageType: Message type (event, exception etc)

InitializeMessage (IChannel, String, String, String, MessageType)    (declared in IMessage)

Initializes message of requested type for interface interfaceName with message name messageName on channel channel.

 

method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)

 

func InitializeMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)

 

Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel: Communication channel
  • libraryName: Library name
  • interfaceName: Interface name
  • messageName: Message name
  • messageType: Message type (event, exception etc)

InitializeMessageEx    (declared in IMessage)

Initializes message of requested type on channel channel.

 

method InitializeMessageEx(channel: IChannel; messageType: MessageType)

 

void InitializeMessageEx(IChannel channel, MessageType messageType)

 

func InitializeMessageEx(_ channel: IChannel, _ messageType: MessageType)

 

Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)

Parameters:

  • channel: Communication channel
  • messageType: Message type (event, exception etc)

InitializeRead    (declared in IMessage)

 

method InitializeRead(channel: IChannel)

 

void InitializeRead(IChannel channel)

 

func InitializeRead(_ channel: IChannel)

 

Sub InitializeRead(channel As IChannel)

Parameters:

  • channel: Communication channnel

InitializeRequest    (declared in IMessage)

Sets additional options of the communication channel and data serializer.

 

method InitializeRequest(channel: IRequest)

 

void InitializeRequest(IRequest channel)

 

func InitializeRequest(_ channel: IRequest)

 

Sub InitializeRequest(channel As IRequest)

Parameters:

  • channel: Communication channnel

InitializeRequestMessage (IChannel, String, String)    (declared in IMessage)

Should be implemented by the Message components to initialize a Request message.

 

method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)

 

func InitializeRequestMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)

 

Sub InitializeRequestMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeRequestMessage (IChannel, String, String, String)    (declared in IMessage)

 

method InitializeRequestMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

func InitializeRequestMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)

 

Sub InitializeRequestMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String)    (declared in IMessage)

Should be implemented by the Message components to initialize a Response message.

 

method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)

 

func InitializeResponseMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)

 

Sub InitializeResponseMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String, String)    (declared in IMessage)

 

method InitializeResponseMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

func InitializeResponseMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)

 

Sub InitializeResponseMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InterfaceName    (declared in IMessage)

Contains the name of the interface or service that is to be or was called on the server.

 

property InterfaceName: String read;

 

String InterfaceName { get; }

 

var InterfaceName: String { get{} }

 

ReadOnly Property InterfaceName() As String

IsEmpty

 

property IsEmpty: Boolean read;

 

Boolean IsEmpty { get; }

 

var IsEmpty: Boolean { get{} }

 

ReadOnly Property IsEmpty() As Boolean

MessageName    (declared in IMessage)

Contains the name of the message (i.e. the method name) that is to be or was called on the server.

 

property MessageName: String read;

 

String MessageName { get; }

 

var MessageName: String { get{} }

 

ReadOnly Property MessageName() As String

MessageType    (declared in IMessage)

Contains the Type of message represented by the message instance.

 

property MessageType: MessageType read;

 

MessageType MessageType { get; }

 

var MessageType: MessageType { get{} }

 

ReadOnly Property MessageType() As MessageType

Read    (declared in IMessage)

Should be implemented to read an object of the given type from the message.

Note: Several overloads are provided for value types to avoid the boxing/unboxing that would occur if these were serialized via the generic Read/Write methods.

 

method Read(name: String; type: Type; format: StreamingFormat): Object

 

Object Read(String name, Type type, StreamingFormat format)

 

func Read(_ name: String, _ type: Type, _ format: StreamingFormat) -> Object

 

Function Read(name As String, type As Type, format As StreamingFormat) As Object

Parameters:

  • name:
  • type:
  • format:

ReadAnsiString    (declared in IMessage)

Should be implemented to read an ANSI String value from the message.

 

method ReadAnsiString(name: String): String

 

String ReadAnsiString(String name)

 

func ReadAnsiString(_ name: String) -> String

 

Function ReadAnsiString(name As String) As String

Parameters:

  • name:

ReadBoolean    (declared in IMessage)

 

method ReadBoolean(name: String): Boolean

 

Boolean ReadBoolean(String name)

 

func ReadBoolean(_ name: String) -> Boolean

 

Function ReadBoolean(name As String) As Boolean

Parameters:

  • name:

ReadCurrency    (declared in IMessage)

 

method ReadCurrency(name: String): Decimal

 

Decimal ReadCurrency(String name)

 

func ReadCurrency(_ name: String) -> Decimal

 

Function ReadCurrency(name As String) As Decimal

Parameters:

  • name:

ReadDateTime    (declared in IMessage)

 

method ReadDateTime(name: String): DateTime

 

DateTime ReadDateTime(String name)

 

func ReadDateTime(_ name: String) -> DateTime

 

Function ReadDateTime(name As String) As DateTime

Parameters:

  • name:

ReadDecimal    (declared in IMessage)

 

method ReadDecimal(name: String): Decimal

 

Decimal ReadDecimal(String name)

 

func ReadDecimal(_ name: String) -> Decimal

 

Function ReadDecimal(name As String) As Decimal

Parameters:

  • name:

ReadDouble    (declared in IMessage)

 

method ReadDouble(name: String): Double

 

Double ReadDouble(String name)

 

func ReadDouble(_ name: String) -> Double

 

Function ReadDouble(name As String) As Double

Parameters:

  • name:

ReadEnum    (declared in IMessage)

 

method ReadEnum(name: String; type: Type): Enum

 

Enum ReadEnum(String name, Type type)

 

func ReadEnum(_ name: String, _ type: Type) -> Enum

 

Function ReadEnum(name As String, type As Type) As Enum

Parameters:

  • name:
  • type:

ReadException    (declared in IMessage)

 

method ReadException: Exception

 

Exception ReadException()

 

func ReadException() -> Exception

 

Function ReadException() As Exception

ReadFromStream    (declared in IMessage)

Should be implemented to read the contents of the message from the given stream.

 

method ReadFromStream(stream: Stream)

 

void ReadFromStream(Stream stream)

 

func ReadFromStream(_ stream: Stream)

 

Sub ReadFromStream(stream As Stream)

Parameters:

  • stream:

ReadGuid    (declared in IMessage)

 

method ReadGuid(name: String): Guid

 

Guid ReadGuid(String name)

 

func ReadGuid(_ name: String) -> Guid

 

Function ReadGuid(name As String) As Guid

Parameters:

  • name:

ReadInt32    (declared in IMessage)

Reads Int32 value.

 

method ReadInt32(name: String): Int32

 

Int32 ReadInt32(String name)

 

func ReadInt32(_ name: String) -> Int32

 

Function ReadInt32(name As String) As Int32

Parameters:

  • name:

ReadInt64    (declared in IMessage)

 

method ReadInt64(name: String): Int64

 

Int64 ReadInt64(String name)

 

func ReadInt64(_ name: String) -> Int64

 

Function ReadInt64(name As String) As Int64

Parameters:

  • name:

ReadNullableBoolean    (declared in IMessage)

 

method ReadNullableBoolean(name: String): nullable Boolean

 

Boolean? ReadNullableBoolean(String name)

 

func ReadNullableBoolean(_ name: String) -> Boolean!

 

Function ReadNullableBoolean(name As String) As Boolean?

Parameters:

  • name:

ReadNullableCurrency    (declared in IMessage)

 

method ReadNullableCurrency(name: String): nullable Decimal

 

Decimal? ReadNullableCurrency(String name)

 

func ReadNullableCurrency(_ name: String) -> Decimal!

 

Function ReadNullableCurrency(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDateTime    (declared in IMessage)

 

method ReadNullableDateTime(name: String): nullable DateTime

 

DateTime? ReadNullableDateTime(String name)

 

func ReadNullableDateTime(_ name: String) -> DateTime!

 

Function ReadNullableDateTime(name As String) As DateTime?

Parameters:

  • name:

ReadNullableDecimal    (declared in IMessage)

 

method ReadNullableDecimal(name: String): nullable Decimal

 

Decimal? ReadNullableDecimal(String name)

 

func ReadNullableDecimal(_ name: String) -> Decimal!

 

Function ReadNullableDecimal(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDouble    (declared in IMessage)

 

method ReadNullableDouble(name: String): nullable Double

 

Double? ReadNullableDouble(String name)

 

func ReadNullableDouble(_ name: String) -> Double!

 

Function ReadNullableDouble(name As String) As Double?

Parameters:

  • name:

ReadNullableEnum    (declared in IMessage)

 

method ReadNullableEnum(name: String; type: Type): nullable Enum

 

Enum? ReadNullableEnum(String name, Type type)

 

func ReadNullableEnum(_ name: String, _ type: Type) -> Enum?

 

Function ReadNullableEnum(name As String, type As Type) As Enum?

Parameters:

  • name:
  • type:

ReadNullableGuid    (declared in IMessage)

 

method ReadNullableGuid(name: String): nullable Guid

 

Guid? ReadNullableGuid(String name)

 

func ReadNullableGuid(_ name: String) -> Guid!

 

Function ReadNullableGuid(name As String) As Guid?

Parameters:

  • name:

ReadNullableInt32    (declared in IMessage)

 

method ReadNullableInt32(name: String): nullable Int32

 

Int32? ReadNullableInt32(String name)

 

func ReadNullableInt32(_ name: String) -> Int32!

 

Function ReadNullableInt32(name As String) As Int32?

Parameters:

  • name:

ReadNullableInt64    (declared in IMessage)

 

method ReadNullableInt64(name: String): nullable Int64

 

Int64? ReadNullableInt64(String name)

 

func ReadNullableInt64(_ name: String) -> Int64!

 

Function ReadNullableInt64(name As String) As Int64?

Parameters:

  • name:

ReadUtf8String    (declared in IMessage)

 

method ReadUtf8String(name: String): String

 

String ReadUtf8String(String name)

 

func ReadUtf8String(_ name: String) -> String

 

Function ReadUtf8String(name As String) As String

Parameters:

  • name:

ReadVariant    (declared in IMessage)

 

method ReadVariant(name: String): Object

 

Object ReadVariant(String name)

 

func ReadVariant(_ name: String) -> Object

 

Function ReadVariant(name As String) As Object

Parameters:

  • name:

ReadWideString    (declared in IMessage)

Should be implemented to read a Unicode Wide String value from the message.

 

method ReadWideString(name: String): String

 

String ReadWideString(String name)

 

func ReadWideString(_ name: String) -> String

 

Function ReadWideString(name As String) As String

Parameters:

  • name:

ReadXml    (declared in IMessage)

 

method ReadXml(name: String): XmlNode

 

XmlNode ReadXml(String name)

 

func ReadXml(_ name: String) -> XmlNode

 

Function ReadXml(name As String) As XmlNode

Parameters:

  • name:

RemapParameters    (declared in IMessage)

 

method RemapParameters(parameters: array of String)

 

void RemapParameters(String[] parameters)

 

func RemapParameters(_ parameters: String...)

 

Sub RemapParameters(parameters As String())

Parameters:

  • parameters:

SerializerInstance    (declared in IMessage)

 

property SerializerInstance: Serializer read;

 

Serializer SerializerInstance { get; }

 

var SerializerInstance: Serializer { get{} }

 

ReadOnly Property SerializerInstance() As Serializer

SetAttributes    (declared in IMessage)

 

method SetAttributes(channel: IChannel; names: array of String; values: array of String)

 

void SetAttributes(IChannel channel, String[] names, String[] values)

 

func SetAttributes(_ channel: IChannel, _ names: String..., _ values: String...)

 

Sub SetAttributes(channel As IChannel, names As String(), values As String())

Parameters:

  • channel:
  • names:
  • values:

Validate    (declared in IMessage)

 

method Validate(content: String): Boolean

 

Boolean Validate(String content)

 

func Validate(_ content: String) -> Boolean

 

Function Validate(content As String) As Boolean

Parameters:

  • content:

Write    (declared in IMessage)

 

method Write(name: String; value: Object; type: Type; format: StreamingFormat)

 

void Write(String name, Object value, Type type, StreamingFormat format)

 

func Write(_ name: String, _ value: Object, _ type: Type, _ format: StreamingFormat)

 

Sub Write(name As String, value As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • type:
  • format:

WriteAnsiString    (declared in IMessage)

Should be implemented to write an ANSI String value to the message.

 

method WriteAnsiString(name: String; value: String)

 

void WriteAnsiString(String name, String value)

 

func WriteAnsiString(_ name: String, _ value: String)

 

Sub WriteAnsiString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteBoolean    (declared in IMessage)

 

method WriteBoolean(name: String; value: Boolean)

 

void WriteBoolean(String name, Boolean value)

 

func WriteBoolean(_ name: String, _ value: Boolean)

 

Sub WriteBoolean(name As String, value As Boolean)

Parameters:

  • name:
  • value:

WriteCurrency    (declared in IMessage)

 

method WriteCurrency(name: String; value: Decimal)

 

void WriteCurrency(String name, Decimal value)

 

func WriteCurrency(_ name: String, _ value: Decimal)

 

Sub WriteCurrency(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDateTime    (declared in IMessage)

 

method WriteDateTime(name: String; value: DateTime)

 

void WriteDateTime(String name, DateTime value)

 

func WriteDateTime(_ name: String, _ value: DateTime)

 

Sub WriteDateTime(name As String, value As DateTime)

Parameters:

  • name:
  • value:

WriteDecimal    (declared in IMessage)

 

method WriteDecimal(name: String; value: Decimal)

 

void WriteDecimal(String name, Decimal value)

 

func WriteDecimal(_ name: String, _ value: Decimal)

 

Sub WriteDecimal(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDouble    (declared in IMessage)

 

method WriteDouble(name: String; value: Double)

 

void WriteDouble(String name, Double value)

 

func WriteDouble(_ name: String, _ value: Double)

 

Sub WriteDouble(name As String, value As Double)

Parameters:

  • name:
  • value:

WriteEnum    (declared in IMessage)

 

method WriteEnum(name: String; value: Enum)

 

void WriteEnum(String name, Enum value)

 

func WriteEnum(_ name: String, _ value: Enum)

 

Sub WriteEnum(name As String, value As Enum)

Parameters:

  • name:
  • value:

WriteException    (declared in IMessage)

 

method WriteException(exception: Exception)

 

void WriteException(Exception exception)

 

func WriteException(_ exception: Exception)

 

Sub WriteException(exception As Exception)

Parameters:

  • exception:

WriteGuid    (declared in IMessage)

 

method WriteGuid(name: String; value: Guid)

 

void WriteGuid(String name, Guid value)

 

func WriteGuid(_ name: String, _ value: Guid)

 

Sub WriteGuid(name As String, value As Guid)

Parameters:

  • name:
  • value:

WriteInt32    (declared in IMessage)

 

method WriteInt32(name: String; value: Int32)

 

void WriteInt32(String name, Int32 value)

 

func WriteInt32(_ name: String, _ value: Int32)

 

Sub WriteInt32(name As String, value As Int32)

Parameters:

  • name:
  • value:

WriteInt64    (declared in IMessage)

 

method WriteInt64(name: String; value: Int64)

 

void WriteInt64(String name, Int64 value)

 

func WriteInt64(_ name: String, _ value: Int64)

 

Sub WriteInt64(name As String, value As Int64)

Parameters:

  • name:
  • value:

WriteNullableBoolean    (declared in IMessage)

 

method WriteNullableBoolean(name: String; value: Nullable<Boolean>)

 

void WriteNullableBoolean(String name, Nullable<Boolean> value)

 

func WriteNullableBoolean(_ name: String, _ value: Nullable<Boolean>)

 

Sub WriteNullableBoolean(name As String, value As Nullable<Boolean>)

Parameters:

  • name:
  • value:

WriteNullableCurrency    (declared in IMessage)

 

method WriteNullableCurrency(name: String; value: Nullable<Decimal>)

 

void WriteNullableCurrency(String name, Nullable<Decimal> value)

 

func WriteNullableCurrency(_ name: String, _ value: Nullable<Decimal>)

 

Sub WriteNullableCurrency(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDateTime    (declared in IMessage)

 

method WriteNullableDateTime(name: String; value: Nullable<DateTime>)

 

void WriteNullableDateTime(String name, Nullable<DateTime> value)

 

func WriteNullableDateTime(_ name: String, _ value: Nullable<DateTime>)

 

Sub WriteNullableDateTime(name As String, value As Nullable<DateTime>)

Parameters:

  • name:
  • value:

WriteNullableDecimal    (declared in IMessage)

 

method WriteNullableDecimal(name: String; value: Nullable<Decimal>)

 

void WriteNullableDecimal(String name, Nullable<Decimal> value)

 

func WriteNullableDecimal(_ name: String, _ value: Nullable<Decimal>)

 

Sub WriteNullableDecimal(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDouble    (declared in IMessage)

 

method WriteNullableDouble(name: String; value: Nullable<Double>)

 

void WriteNullableDouble(String name, Nullable<Double> value)

 

func WriteNullableDouble(_ name: String, _ value: Nullable<Double>)

 

Sub WriteNullableDouble(name As String, value As Nullable<Double>)

Parameters:

  • name:
  • value:

WriteNullableEnum    (declared in IMessage)

 

method WriteNullableEnum(name: String; value: nullable Enum)

 

void WriteNullableEnum(String name, Enum? value)

 

func WriteNullableEnum(_ name: String, _ value: Enum?)

 

Sub WriteNullableEnum(name As String, value As Enum?)

Parameters:

  • name:
  • value:

WriteNullableGuid    (declared in IMessage)

 

method WriteNullableGuid(name: String; value: Nullable<Guid>)

 

void WriteNullableGuid(String name, Nullable<Guid> value)

 

func WriteNullableGuid(_ name: String, _ value: Nullable<Guid>)

 

Sub WriteNullableGuid(name As String, value As Nullable<Guid>)

Parameters:

  • name:
  • value:

WriteNullableInt32    (declared in IMessage)

 

method WriteNullableInt32(name: String; value: Nullable<Int32>)

 

void WriteNullableInt32(String name, Nullable<Int32> value)

 

func WriteNullableInt32(_ name: String, _ value: Nullable<Int32>)

 

Sub WriteNullableInt32(name As String, value As Nullable<Int32>)

Parameters:

  • name:
  • value:

WriteNullableInt64    (declared in IMessage)

 

method WriteNullableInt64(name: String; value: Nullable<Int64>)

 

void WriteNullableInt64(String name, Nullable<Int64> value)

 

func WriteNullableInt64(_ name: String, _ value: Nullable<Int64>)

 

Sub WriteNullableInt64(name As String, value As Nullable<Int64>)

Parameters:

  • name:
  • value:

WriteToStream    (declared in IMessage)

 

method WriteToStream(stream: Stream)

 

void WriteToStream(Stream stream)

 

func WriteToStream(_ stream: Stream)

 

Sub WriteToStream(stream As Stream)

Parameters:

  • stream:

WriteUtf8String    (declared in IMessage)

 

method WriteUtf8String(name: String; value: String)

 

void WriteUtf8String(String name, String value)

 

func WriteUtf8String(_ name: String, _ value: String)

 

Sub WriteUtf8String(name As String, value As String)

Parameters:

  • name:
  • value:

WriteVariant    (declared in IMessage)

 

method WriteVariant(name: String; value: Object)

 

void WriteVariant(String name, Object value)

 

func WriteVariant(_ name: String, _ value: Object)

 

Sub WriteVariant(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteWideString    (declared in IMessage)

 

method WriteWideString(name: String; value: String)

 

void WriteWideString(String name, String value)

 

func WriteWideString(_ name: String, _ value: String)

 

Sub WriteWideString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteXml    (declared in IMessage)

 

method WriteXml(name: String; value: XmlNode)

 

void WriteXml(String name, XmlNode value)

 

func WriteXml(_ name: String, _ value: XmlNode)

 

Sub WriteXml(name As String, value As XmlNode)

Parameters:

  • name:
  • value:

 

ClientID    (declared in IMessage)

Provides access to the ClientID read from the message.

 

property ClientID: Guid read write;

 

Guid ClientID { get; set; }

 

var ClientID: Guid { get{} set{} }

 

Property ClientID() As Guid

ContentDisposition

 

property ContentDisposition: String read;

 

String ContentDisposition { get; }

 

var ContentDisposition: String { get{} }

 

ReadOnly Property ContentDisposition() As String

ContentType    (declared in IMessage)

Gets message's content type.

 

property ContentType: String read;

 

String ContentType { get; }

 

var ContentType: String { get{} }

 

ReadOnly Property ContentType() As String

DefaultDispatcherName    (declared in IMessage)

Returns the default/recommended dispatcher name for the message type.

 

property DefaultDispatcherName: String read;

 

String DefaultDispatcherName { get; }

 

var DefaultDispatcherName: String { get{} }

 

ReadOnly Property DefaultDispatcherName() As String

HttpStatusCode

 

property HttpStatusCode: Int32 read;

 

Int32 HttpStatusCode { get; }

 

var HttpStatusCode: Int32 { get{} }

 

ReadOnly Property HttpStatusCode() As Int32

InterfaceName    (declared in IMessage)

Contains the name of the interface or service that is to be or was called on the server.

 

property InterfaceName: String read;

 

String InterfaceName { get; }

 

var InterfaceName: String { get{} }

 

ReadOnly Property InterfaceName() As String

IsEmpty

 

property IsEmpty: Boolean read;

 

Boolean IsEmpty { get; }

 

var IsEmpty: Boolean { get{} }

 

ReadOnly Property IsEmpty() As Boolean

MessageName    (declared in IMessage)

Contains the name of the message (i.e. the method name) that is to be or was called on the server.

 

property MessageName: String read;

 

String MessageName { get; }

 

var MessageName: String { get{} }

 

ReadOnly Property MessageName() As String

MessageType    (declared in IMessage)

Contains the Type of message represented by the message instance.

 

property MessageType: MessageType read;

 

MessageType MessageType { get; }

 

var MessageType: MessageType { get{} }

 

ReadOnly Property MessageType() As MessageType

SerializerInstance    (declared in IMessage)

 

property SerializerInstance: Serializer read;

 

Serializer SerializerInstance { get; }

 

var SerializerInstance: Serializer { get{} }

 

ReadOnly Property SerializerInstance() As Serializer

 

CanRemapParameters    (declared in IMessage)

 

method CanRemapParameters: Boolean

 

Boolean CanRemapParameters()

 

func CanRemapParameters() -> Boolean

 

Function CanRemapParameters() As Boolean

Clear    (declared in IMessage)

Clear the contents of the message.

 

method Clear

 

void Clear()

 

func Clear()

 

Sub Clear()

ClearAttributes    (declared in IMessage)

Clears internally set serializer options based on the attribute values and/or HTTP headers.

 

method ClearAttributes(channel: IChannel)

 

void ClearAttributes(IChannel channel)

 

func ClearAttributes(_ channel: IChannel)

 

Sub ClearAttributes(channel As IChannel)

Parameters:

  • channel: Communication channel

Clone    (declared in IMessage)

Creates and returns an identical copy of the message.

 

method Clone: IMessage

 

IMessage Clone()

 

func Clone() -> IMessage

 

Function Clone() As IMessage

FinalizeMessage    (declared in IMessage)

Should be implemented to ensure that the message content is complete before sending it by doing any final processing necessary.

This method is called after all Parameters have been written to a Message and before the message will be sent. It should perform any necessary wrap-up to ensure that a subsequent call to WriteToStream() will produce a complete message.

 

method FinalizeMessage

 

void FinalizeMessage()

 

func FinalizeMessage()

 

Sub FinalizeMessage()

FinalizeRequest    (declared in IMessage)

Finalizes the data request serialization.

 

method FinalizeRequest(channel: IRequest)

 

void FinalizeRequest(IRequest channel)

 

func FinalizeRequest(_ channel: IRequest)

 

Sub FinalizeRequest(channel As IRequest)

Parameters:

  • channel: Communication channel

GetStream    (declared in IMessage)

Creates a new stream with the content of the message.

 

method GetStream: Stream

 

Stream GetStream()

 

func GetStream() -> Stream

 

Function GetStream() As Stream

InitializeEventMessage (IChannel, String, String)    (declared in IMessage)

This method should be implemented by the Message components to initialize an Event message.

 

method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)

 

func InitializeEventMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)

 

Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel: Communication channel that will be used to send the event message
  • interfaceName: Communication channel that will be used to send the event message
  • messageName: Message name. Corresponds to the name of the service method being executed

InitializeEventMessage (IChannel, String, String, String)    (declared in IMessage)

Initializes new event message for interface interfaceName with message name messageName on channel channel.

 

method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

func InitializeEventMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)

 

Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel: Communication channel that will be used to send the event message
  • libraryName: RODL library name
  • interfaceName: Communication channel that will be used to send the event message
  • messageName: Message name. Corresponds to the name of the service method being executed

InitializeExceptionMessage (IChannel, String, String, Exception)    (declared in IMessage)

Initializes new exception message for interface interfaceName with message name messageName on channel channel.

 

method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; e: Exception)

 

void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception e)

 

func InitializeExceptionMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ e: Exception)

 

Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, e As Exception)

Parameters:

  • channel: Communication channel that will be used to send the exception message
  • interfaceName: A name of the interface (i.e. the service).
  • messageName: Message name. Corresponds to the name of the service method being executed
  • e: Exception that should be serialized and sent to the client application

InitializeExceptionMessage (IChannel, String, String, String, Exception)    (declared in IMessage)

Initializes new exception message for interface interfaceName with message name messageName on channel channel.

 

method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; e: Exception)

 

void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception e)

 

func InitializeExceptionMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ e: Exception)

 

Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, e As Exception)

Parameters:

  • channel: Communication channel that will be used to send the exception message
  • libraryName: RODL library name
  • interfaceName: A name of the interface (i.e. the service).
  • messageName: Message name. Corresponds to the name of the service method being executed
  • e: Exception that should be serialized and sent to the client application

InitializeMessage (IChannel, String, String, MessageType)    (declared in IMessage)

Initializes message of requested type for interface interfaceName with message name messageName on channel channel.

 

method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)

 

func InitializeMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)

 

Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel: Communication channel
  • interfaceName: Interface name
  • messageName: Message name
  • messageType: Message type (event, exception etc)

InitializeMessage (IChannel, String, String, String, MessageType)    (declared in IMessage)

Initializes message of requested type for interface interfaceName with message name messageName on channel channel.

 

method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)

 

func InitializeMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)

 

Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel: Communication channel
  • libraryName: Library name
  • interfaceName: Interface name
  • messageName: Message name
  • messageType: Message type (event, exception etc)

InitializeMessageEx    (declared in IMessage)

Initializes message of requested type on channel channel.

 

method InitializeMessageEx(channel: IChannel; messageType: MessageType)

 

void InitializeMessageEx(IChannel channel, MessageType messageType)

 

func InitializeMessageEx(_ channel: IChannel, _ messageType: MessageType)

 

Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)

Parameters:

  • channel: Communication channel
  • messageType: Message type (event, exception etc)

InitializeRead    (declared in IMessage)

 

method InitializeRead(channel: IChannel)

 

void InitializeRead(IChannel channel)

 

func InitializeRead(_ channel: IChannel)

 

Sub InitializeRead(channel As IChannel)

Parameters:

  • channel: Communication channnel

InitializeRequest    (declared in IMessage)

Sets additional options of the communication channel and data serializer.

 

method InitializeRequest(channel: IRequest)

 

void InitializeRequest(IRequest channel)

 

func InitializeRequest(_ channel: IRequest)

 

Sub InitializeRequest(channel As IRequest)

Parameters:

  • channel: Communication channnel

InitializeRequestMessage (IChannel, String, String)    (declared in IMessage)

Should be implemented by the Message components to initialize a Request message.

 

method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)

 

func InitializeRequestMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)

 

Sub InitializeRequestMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeRequestMessage (IChannel, String, String, String)    (declared in IMessage)

 

method InitializeRequestMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

func InitializeRequestMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)

 

Sub InitializeRequestMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String)    (declared in IMessage)

Should be implemented by the Message components to initialize a Response message.

 

method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)

 

func InitializeResponseMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)

 

Sub InitializeResponseMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String, String)    (declared in IMessage)

 

method InitializeResponseMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

func InitializeResponseMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)

 

Sub InitializeResponseMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

Read    (declared in IMessage)

Should be implemented to read an object of the given type from the message.

Note: Several overloads are provided for value types to avoid the boxing/unboxing that would occur if these were serialized via the generic Read/Write methods.

 

method Read(name: String; type: Type; format: StreamingFormat): Object

 

Object Read(String name, Type type, StreamingFormat format)

 

func Read(_ name: String, _ type: Type, _ format: StreamingFormat) -> Object

 

Function Read(name As String, type As Type, format As StreamingFormat) As Object

Parameters:

  • name:
  • type:
  • format:

ReadAnsiString    (declared in IMessage)

Should be implemented to read an ANSI String value from the message.

 

method ReadAnsiString(name: String): String

 

String ReadAnsiString(String name)

 

func ReadAnsiString(_ name: String) -> String

 

Function ReadAnsiString(name As String) As String

Parameters:

  • name:

ReadBoolean    (declared in IMessage)

 

method ReadBoolean(name: String): Boolean

 

Boolean ReadBoolean(String name)

 

func ReadBoolean(_ name: String) -> Boolean

 

Function ReadBoolean(name As String) As Boolean

Parameters:

  • name:

ReadCurrency    (declared in IMessage)

 

method ReadCurrency(name: String): Decimal

 

Decimal ReadCurrency(String name)

 

func ReadCurrency(_ name: String) -> Decimal

 

Function ReadCurrency(name As String) As Decimal

Parameters:

  • name:

ReadDateTime    (declared in IMessage)

 

method ReadDateTime(name: String): DateTime

 

DateTime ReadDateTime(String name)

 

func ReadDateTime(_ name: String) -> DateTime

 

Function ReadDateTime(name As String) As DateTime

Parameters:

  • name:

ReadDecimal    (declared in IMessage)

 

method ReadDecimal(name: String): Decimal

 

Decimal ReadDecimal(String name)

 

func ReadDecimal(_ name: String) -> Decimal

 

Function ReadDecimal(name As String) As Decimal

Parameters:

  • name:

ReadDouble    (declared in IMessage)

 

method ReadDouble(name: String): Double

 

Double ReadDouble(String name)

 

func ReadDouble(_ name: String) -> Double

 

Function ReadDouble(name As String) As Double

Parameters:

  • name:

ReadEnum    (declared in IMessage)

 

method ReadEnum(name: String; type: Type): Enum

 

Enum ReadEnum(String name, Type type)

 

func ReadEnum(_ name: String, _ type: Type) -> Enum

 

Function ReadEnum(name As String, type As Type) As Enum

Parameters:

  • name:
  • type:

ReadException    (declared in IMessage)

 

method ReadException: Exception

 

Exception ReadException()

 

func ReadException() -> Exception

 

Function ReadException() As Exception

ReadFromStream    (declared in IMessage)

Should be implemented to read the contents of the message from the given stream.

 

method ReadFromStream(stream: Stream)

 

void ReadFromStream(Stream stream)

 

func ReadFromStream(_ stream: Stream)

 

Sub ReadFromStream(stream As Stream)

Parameters:

  • stream:

ReadGuid    (declared in IMessage)

 

method ReadGuid(name: String): Guid

 

Guid ReadGuid(String name)

 

func ReadGuid(_ name: String) -> Guid

 

Function ReadGuid(name As String) As Guid

Parameters:

  • name:

ReadInt32    (declared in IMessage)

Reads Int32 value.

 

method ReadInt32(name: String): Int32

 

Int32 ReadInt32(String name)

 

func ReadInt32(_ name: String) -> Int32

 

Function ReadInt32(name As String) As Int32

Parameters:

  • name:

ReadInt64    (declared in IMessage)

 

method ReadInt64(name: String): Int64

 

Int64 ReadInt64(String name)

 

func ReadInt64(_ name: String) -> Int64

 

Function ReadInt64(name As String) As Int64

Parameters:

  • name:

ReadNullableBoolean    (declared in IMessage)

 

method ReadNullableBoolean(name: String): nullable Boolean

 

Boolean? ReadNullableBoolean(String name)

 

func ReadNullableBoolean(_ name: String) -> Boolean!

 

Function ReadNullableBoolean(name As String) As Boolean?

Parameters:

  • name:

ReadNullableCurrency    (declared in IMessage)

 

method ReadNullableCurrency(name: String): nullable Decimal

 

Decimal? ReadNullableCurrency(String name)

 

func ReadNullableCurrency(_ name: String) -> Decimal!

 

Function ReadNullableCurrency(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDateTime    (declared in IMessage)

 

method ReadNullableDateTime(name: String): nullable DateTime

 

DateTime? ReadNullableDateTime(String name)

 

func ReadNullableDateTime(_ name: String) -> DateTime!

 

Function ReadNullableDateTime(name As String) As DateTime?

Parameters:

  • name:

ReadNullableDecimal    (declared in IMessage)

 

method ReadNullableDecimal(name: String): nullable Decimal

 

Decimal? ReadNullableDecimal(String name)

 

func ReadNullableDecimal(_ name: String) -> Decimal!

 

Function ReadNullableDecimal(name As String) As Decimal?

Parameters:

  • name:

ReadNullableDouble    (declared in IMessage)

 

method ReadNullableDouble(name: String): nullable Double

 

Double? ReadNullableDouble(String name)

 

func ReadNullableDouble(_ name: String) -> Double!

 

Function ReadNullableDouble(name As String) As Double?

Parameters:

  • name:

ReadNullableEnum    (declared in IMessage)

 

method ReadNullableEnum(name: String; type: Type): nullable Enum

 

Enum? ReadNullableEnum(String name, Type type)

 

func ReadNullableEnum(_ name: String, _ type: Type) -> Enum?

 

Function ReadNullableEnum(name As String, type As Type) As Enum?

Parameters:

  • name:
  • type:

ReadNullableGuid    (declared in IMessage)

 

method ReadNullableGuid(name: String): nullable Guid

 

Guid? ReadNullableGuid(String name)

 

func ReadNullableGuid(_ name: String) -> Guid!

 

Function ReadNullableGuid(name As String) As Guid?

Parameters:

  • name:

ReadNullableInt32    (declared in IMessage)

 

method ReadNullableInt32(name: String): nullable Int32

 

Int32? ReadNullableInt32(String name)

 

func ReadNullableInt32(_ name: String) -> Int32!

 

Function ReadNullableInt32(name As String) As Int32?

Parameters:

  • name:

ReadNullableInt64    (declared in IMessage)

 

method ReadNullableInt64(name: String): nullable Int64

 

Int64? ReadNullableInt64(String name)

 

func ReadNullableInt64(_ name: String) -> Int64!

 

Function ReadNullableInt64(name As String) As Int64?

Parameters:

  • name:

ReadUtf8String    (declared in IMessage)

 

method ReadUtf8String(name: String): String

 

String ReadUtf8String(String name)

 

func ReadUtf8String(_ name: String) -> String

 

Function ReadUtf8String(name As String) As String

Parameters:

  • name:

ReadVariant    (declared in IMessage)

 

method ReadVariant(name: String): Object

 

Object ReadVariant(String name)

 

func ReadVariant(_ name: String) -> Object

 

Function ReadVariant(name As String) As Object

Parameters:

  • name:

ReadWideString    (declared in IMessage)

Should be implemented to read a Unicode Wide String value from the message.

 

method ReadWideString(name: String): String

 

String ReadWideString(String name)

 

func ReadWideString(_ name: String) -> String

 

Function ReadWideString(name As String) As String

Parameters:

  • name:

ReadXml    (declared in IMessage)

 

method ReadXml(name: String): XmlNode

 

XmlNode ReadXml(String name)

 

func ReadXml(_ name: String) -> XmlNode

 

Function ReadXml(name As String) As XmlNode

Parameters:

  • name:

RemapParameters    (declared in IMessage)

 

method RemapParameters(parameters: array of String)

 

void RemapParameters(String[] parameters)

 

func RemapParameters(_ parameters: String...)

 

Sub RemapParameters(parameters As String())

Parameters:

  • parameters:

SetAttributes    (declared in IMessage)

 

method SetAttributes(channel: IChannel; names: array of String; values: array of String)

 

void SetAttributes(IChannel channel, String[] names, String[] values)

 

func SetAttributes(_ channel: IChannel, _ names: String..., _ values: String...)

 

Sub SetAttributes(channel As IChannel, names As String(), values As String())

Parameters:

  • channel:
  • names:
  • values:

Validate    (declared in IMessage)

 

method Validate(content: String): Boolean

 

Boolean Validate(String content)

 

func Validate(_ content: String) -> Boolean

 

Function Validate(content As String) As Boolean

Parameters:

  • content:

Write    (declared in IMessage)

 

method Write(name: String; value: Object; type: Type; format: StreamingFormat)

 

void Write(String name, Object value, Type type, StreamingFormat format)

 

func Write(_ name: String, _ value: Object, _ type: Type, _ format: StreamingFormat)

 

Sub Write(name As String, value As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • type:
  • format:

WriteAnsiString    (declared in IMessage)

Should be implemented to write an ANSI String value to the message.

 

method WriteAnsiString(name: String; value: String)

 

void WriteAnsiString(String name, String value)

 

func WriteAnsiString(_ name: String, _ value: String)

 

Sub WriteAnsiString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteBoolean    (declared in IMessage)

 

method WriteBoolean(name: String; value: Boolean)

 

void WriteBoolean(String name, Boolean value)

 

func WriteBoolean(_ name: String, _ value: Boolean)

 

Sub WriteBoolean(name As String, value As Boolean)

Parameters:

  • name:
  • value:

WriteCurrency    (declared in IMessage)

 

method WriteCurrency(name: String; value: Decimal)

 

void WriteCurrency(String name, Decimal value)

 

func WriteCurrency(_ name: String, _ value: Decimal)

 

Sub WriteCurrency(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDateTime    (declared in IMessage)

 

method WriteDateTime(name: String; value: DateTime)

 

void WriteDateTime(String name, DateTime value)

 

func WriteDateTime(_ name: String, _ value: DateTime)

 

Sub WriteDateTime(name As String, value As DateTime)

Parameters:

  • name:
  • value:

WriteDecimal    (declared in IMessage)

 

method WriteDecimal(name: String; value: Decimal)

 

void WriteDecimal(String name, Decimal value)

 

func WriteDecimal(_ name: String, _ value: Decimal)

 

Sub WriteDecimal(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDouble    (declared in IMessage)

 

method WriteDouble(name: String; value: Double)

 

void WriteDouble(String name, Double value)

 

func WriteDouble(_ name: String, _ value: Double)

 

Sub WriteDouble(name As String, value As Double)

Parameters:

  • name:
  • value:

WriteEnum    (declared in IMessage)

 

method WriteEnum(name: String; value: Enum)

 

void WriteEnum(String name, Enum value)

 

func WriteEnum(_ name: String, _ value: Enum)

 

Sub WriteEnum(name As String, value As Enum)

Parameters:

  • name:
  • value:

WriteException    (declared in IMessage)

 

method WriteException(exception: Exception)

 

void WriteException(Exception exception)

 

func WriteException(_ exception: Exception)

 

Sub WriteException(exception As Exception)

Parameters:

  • exception:

WriteGuid    (declared in IMessage)

 

method WriteGuid(name: String; value: Guid)

 

void WriteGuid(String name, Guid value)

 

func WriteGuid(_ name: String, _ value: Guid)

 

Sub WriteGuid(name As String, value As Guid)

Parameters:

  • name:
  • value:

WriteInt32    (declared in IMessage)

 

method WriteInt32(name: String; value: Int32)

 

void WriteInt32(String name, Int32 value)

 

func WriteInt32(_ name: String, _ value: Int32)

 

Sub WriteInt32(name As String, value As Int32)

Parameters:

  • name:
  • value:

WriteInt64    (declared in IMessage)

 

method WriteInt64(name: String; value: Int64)

 

void WriteInt64(String name, Int64 value)

 

func WriteInt64(_ name: String, _ value: Int64)

 

Sub WriteInt64(name As String, value As Int64)

Parameters:

  • name:
  • value:

WriteNullableBoolean    (declared in IMessage)

 

method WriteNullableBoolean(name: String; value: Nullable<Boolean>)

 

void WriteNullableBoolean(String name, Nullable<Boolean> value)

 

func WriteNullableBoolean(_ name: String, _ value: Nullable<Boolean>)

 

Sub WriteNullableBoolean(name As String, value As Nullable<Boolean>)

Parameters:

  • name:
  • value:

WriteNullableCurrency    (declared in IMessage)

 

method WriteNullableCurrency(name: String; value: Nullable<Decimal>)

 

void WriteNullableCurrency(String name, Nullable<Decimal> value)

 

func WriteNullableCurrency(_ name: String, _ value: Nullable<Decimal>)

 

Sub WriteNullableCurrency(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDateTime    (declared in IMessage)

 

method WriteNullableDateTime(name: String; value: Nullable<DateTime>)

 

void WriteNullableDateTime(String name, Nullable<DateTime> value)

 

func WriteNullableDateTime(_ name: String, _ value: Nullable<DateTime>)

 

Sub WriteNullableDateTime(name As String, value As Nullable<DateTime>)

Parameters:

  • name:
  • value:

WriteNullableDecimal    (declared in IMessage)

 

method WriteNullableDecimal(name: String; value: Nullable<Decimal>)

 

void WriteNullableDecimal(String name, Nullable<Decimal> value)

 

func WriteNullableDecimal(_ name: String, _ value: Nullable<Decimal>)

 

Sub WriteNullableDecimal(name As String, value As Nullable<Decimal>)

Parameters:

  • name:
  • value:

WriteNullableDouble    (declared in IMessage)

 

method WriteNullableDouble(name: String; value: Nullable<Double>)

 

void WriteNullableDouble(String name, Nullable<Double> value)

 

func WriteNullableDouble(_ name: String, _ value: Nullable<Double>)

 

Sub WriteNullableDouble(name As String, value As Nullable<Double>)

Parameters:

  • name:
  • value:

WriteNullableEnum    (declared in IMessage)

 

method WriteNullableEnum(name: String; value: nullable Enum)

 

void WriteNullableEnum(String name, Enum? value)

 

func WriteNullableEnum(_ name: String, _ value: Enum?)

 

Sub WriteNullableEnum(name As String, value As Enum?)

Parameters:

  • name:
  • value:

WriteNullableGuid    (declared in IMessage)

 

method WriteNullableGuid(name: String; value: Nullable<Guid>)

 

void WriteNullableGuid(String name, Nullable<Guid> value)

 

func WriteNullableGuid(_ name: String, _ value: Nullable<Guid>)

 

Sub WriteNullableGuid(name As String, value As Nullable<Guid>)

Parameters:

  • name:
  • value:

WriteNullableInt32    (declared in IMessage)

 

method WriteNullableInt32(name: String; value: Nullable<Int32>)

 

void WriteNullableInt32(String name, Nullable<Int32> value)

 

func WriteNullableInt32(_ name: String, _ value: Nullable<Int32>)

 

Sub WriteNullableInt32(name As String, value As Nullable<Int32>)

Parameters:

  • name:
  • value:

WriteNullableInt64    (declared in IMessage)

 

method WriteNullableInt64(name: String; value: Nullable<Int64>)

 

void WriteNullableInt64(String name, Nullable<Int64> value)

 

func WriteNullableInt64(_ name: String, _ value: Nullable<Int64>)

 

Sub WriteNullableInt64(name As String, value As Nullable<Int64>)

Parameters:

  • name:
  • value:

WriteToStream    (declared in IMessage)

 

method WriteToStream(stream: Stream)

 

void WriteToStream(Stream stream)

 

func WriteToStream(_ stream: Stream)

 

Sub WriteToStream(stream As Stream)

Parameters:

  • stream:

WriteUtf8String    (declared in IMessage)

 

method WriteUtf8String(name: String; value: String)

 

void WriteUtf8String(String name, String value)

 

func WriteUtf8String(_ name: String, _ value: String)

 

Sub WriteUtf8String(name As String, value As String)

Parameters:

  • name:
  • value:

WriteVariant    (declared in IMessage)

 

method WriteVariant(name: String; value: Object)

 

void WriteVariant(String name, Object value)

 

func WriteVariant(_ name: String, _ value: Object)

 

Sub WriteVariant(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteWideString    (declared in IMessage)

 

method WriteWideString(name: String; value: String)

 

void WriteWideString(String name, String value)

 

func WriteWideString(_ name: String, _ value: String)

 

Sub WriteWideString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteXml    (declared in IMessage)

 

method WriteXml(name: String; value: XmlNode)

 

void WriteXml(String name, XmlNode value)

 

func WriteXml(_ name: String, _ value: XmlNode)

 

Sub WriteXml(name As String, value As XmlNode)

Parameters:

  • name:
  • value: