XRoadMessage

Namespace: XRoadLib.Serialization

Deserialized content of X-Road message (input or output).

Constructors

Constructor	Description
`new()` Signature: unit -> unit	Initializes new empty X-Road message for deserialization.
`new(serviceManager, header)` Signature: (serviceManager:IServiceManager * header:IXRoadHeader) -> unit	Initializes new empty X-Road message for request serialization.
`new(contentStream)` Signature: contentStream:Stream -> unit	Initializes new empty X-Road message for response serialization.

Instance members

Instance member	Description
`AllAttachments` Signature: IList<XRoadAttachment> Modifiers: abstract	All attachments (including inline content) that are packaged together with current X-Road message.
`BinaryMode()` Signature: unit -> unit	Serialization format for binary content.
`ContentEncoding()` Signature: unit -> unit	Encoding that is used to transfer X-Road message content.
`ContentLength()` Signature: unit -> unit	Entire length of the X-Road message in serialized form.
`ContentStream()` Signature: unit -> unit	XML document part of the X-Road message.
`Copy(message)` Signature: message:XRoadMessage -> unit	Copy X-Road message parts from another message, which are required to be consistent across multiple possible protocol implementations or service versions.
`Dispose()` Signature: unit -> unit Modifiers: abstract	Clean up unmanaged resources allocated by the X-Road message.
`EnableFilter(filterName)` Signature: filterName:string -> unit	Enable filtering for X-Road message, using the filter specified by name.
`EnableFiltering()` Signature: unit -> unit	When enabled, serialization/deserialization process applies filter specified in FilterName field, to exclude certain elements from outgoing messages, or ignore their values in incoming messages.
`FilterName()` Signature: unit -> unit	Specifies filter which is used on this particular X-Road message, when EnableFiltering is set to true.
`GetAttachment(contentID)` Signature: contentID:string -> XRoadAttachment Modifiers: abstract	Find X-Road message attachment by content ID.
`GetSerializer()` Signature: unit -> ISerializer	Get type lookup object which is used to serialize or deserialize current X-Road message.
`Header()` Signature: unit -> unit	X-Road protocol compliant header values extracted from SOAP header of the message.
`IsMultipartContainer()` Signature: unit -> unit	Shows if this X-Road message wrapped inside MIME multipart container.
`LoadRequest(...)` Signature: (stream:Stream * contentTypeHeader:string * storagePath:string * serviceManager:IServiceManager) -> unit	Loads X-Road message contents from request message.
`LoadRequest(...)` Signature: (stream:Stream * contentTypeHeader:string * storagePath:string * serviceManagers:IEnumerable<IServiceManager>) -> unit	Loads X-Road message contents from request message.
`LoadResponse(...)` Signature: (stream:Stream * contentTypeHeader:string * storagePath:string * serviceManager:IServiceManager) -> unit	Loads X-Road message contents from response message.
`LoadResponse(...)` Signature: (stream:Stream * contentTypeHeader:string * storagePath:string * serviceManagers:IEnumerable<IServiceManager>) -> unit	Loads X-Road message contents from response message.
`MetaServiceMap()` Signature: unit -> unit	When X-Road message represents X-Road meta service operation, this property is assigned to correct service map to handle the operation.
`MultipartContentAttachments` Signature: IEnumerable<XRoadAttachment> Modifiers: abstract	Multipart attachments that are packaged together with current X-Road message.
`MultipartContentType()` Signature: unit -> unit	Content type of the MIME multipart message container.
`RequestNode` Signature: IXmlTemplateNode	X-Road message template request element root node.
`ResponseNode` Signature: IXmlTemplateNode	X-Road message template response element root node.
`RootElementName()` Signature: unit -> unit	Identifies operation name for the X-Road message.
`SaveTo(webRequest)` Signature: webRequest:WebRequest -> unit	Serializes X-Road message into specified web request.
`SaveTo(...)` Signature: (outputStream:Stream * setContentType:Action<string> * appendHeader:Action<string,string>) -> unit	Serializes X-Road message into specified stream.
`ServiceManager()` Signature: unit -> unit
`Style` Signature: Style	X-Road message style used to serialize/deserialize this message.
`UnresolvedHeaders()` Signature: unit -> unit	Remaining non-standard elements in X-Road message header.
`Version` Signature: uint32	Operation version of current X-Road message.
`XmlTemplate()` Signature: unit -> unit	Allows to limit depth of serialization/deserialization for recursive type definitions. Template allows to skip serialization of certain XML elements of the X-Road message (elements are present in document, but set to null even if type contains value). For deserialization incoming elements are ignored even if they contain value.