Class CustomRequestDTO

Custom request parameters used when passing data to a custom request handler.

Inheritance

object

CustomRequestDTO

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Integration.DataContracts

Syntax

[DataContract]
[KnownType(typeof(DataTable))]
[KnownType(typeof(Dictionary<string, object>))]
[KnownType(typeof(List<object>))]
[KnownType(typeof(string[]))]
[KnownType(typeof(int[]))]
public class CustomRequestDTO

Remarks

The object value in the Data property can be a built-in value type, byte array, DataTable, Dictionary(string, object), List(object), string array or int array. The dictionary and list value can contain nested values of the same types listed above. Note that if you want to use other types you can handle serialization in the client and request handler and pass the serialized version of the object as a byte[] or string, e.g. using protobuf to serialize DataSet objects.

Properties

Data

Key-value collection of custom data parameters to pass to your request handler. This can be anything that the client application and handler has agreed upon, e.g. a string key and a string value or a destination table name and a data table.

Declaration

[DataMember(IsRequired = true)]
public IDictionary<string, object> Data { get; set; }

Property Value

Type	Description
IDictionary<string, object>	Key-value collection of custom data parameters.

Remarks

The object value in the Data property can be a built-in value type, byte array, DataTable, Dictionary(string, object), List(object), string array or int array. The dictionary and list value can contain nested values of the same types listed above. Note that if you want to use other types you can handle serialization in the client and request handler and pass the serialized version of the object as a byte[] or string, e.g. using protobuf to serialize DataSet objects.

HandlerName

The full name of the custom request handler that's the recipient of the Data property. This is the full name of the type, e.g. "MyNamespace.MyCustomHandler".

Declaration

[DataMember(IsRequired = true)]
public string HandlerName { get; set; }

Property Value

Type	Description
string	The name of the handler.

Remarks

The object value in the Data property can be a built-in value type, byte array, DataTable, Dictionary(string, object), List(object), string array or int array. The dictionary and list value can contain nested values of the same types listed above. Note that if you want to use other types you can handle serialization in the client and request handler and pass the serialized version of the object as a byte[] or string, e.g. using protobuf to serialize DataSet objects.