Class WorkingDocumentMessageBase

Abstract class, representation of a work document.

Inheritance

object

PlatinaMessageBase

CustomRequestHeaderMessageBase

WorkingDocumentMessageBase

CreateCustomObjectRequest

CreateDeedOnPostListRequest

CreateDeedRequest

RegisterDocumentOnPostListRequest

Implements

IDisposable

Inherited Members

CustomRequestHeaderMessageBase.CustomParameters

PlatinaMessageBase.UserName

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Integration.DataContracts

Syntax

[MessageContract]
public abstract class WorkingDocumentMessageBase : CustomRequestHeaderMessageBase, IDisposable

Properties

WorkingDocumentContent

The streamed bytes of the document to be created.

Declaration

[MessageBodyMember]
public Stream WorkingDocumentContent { get; set; }

Property Value

Type	Description
Stream	The streamed bytes of the document to be created.

WorkingDocumentDescription

The description of the document to be created.

Declaration

[MessageHeader]
public string WorkingDocumentDescription { get; set; }

Property Value

Type	Description
string	The description of the document to be created.

WorkingDocumentExtension

The file extension of the document to be created.

Declaration

[MessageHeader]
public string WorkingDocumentExtension { get; set; }

Property Value

Type	Description
string	The file extension of the document to be created.

Examples

.docx, .pdf etc.

WorkingDocumentFileContentLength

The length of the file content (in bytes) of the document to be created.

Declaration

[MessageHeader]
public long WorkingDocumentFileContentLength { get; set; }

Property Value

Type	Description
long	The length of the file content (in bytes) of the document to be created.

WorkingDocumentTemplateID

The document template id of the document to be created.

Declaration

[MessageHeader]
public int WorkingDocumentTemplateID { get; set; }

Property Value

Type	Description
int	The document template id of the document to be created.

Remarks

Should be mapped to data being returned by IMappingDataProvider

WorkingDocumentTitle

The title of the document to be created.

Declaration

[MessageHeader]
public string WorkingDocumentTitle { get; set; }

Property Value

Type	Description
string	The title of the document to be created.

WorkingDocumentTypeID

The document type id of the document to be created.

Declaration

[MessageHeader]
public string WorkingDocumentTypeID { get; set; }

Property Value

Type	Description
string	The document type id of the document to be created.

Remarks

Should be mapped to data being returned by IMappingDataProvider

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

IsValid()

Check if message request is valid.

Declaration

public override IsValidResult IsValid()

Returns

Type	Description
IsValidResult	IsValidResult containing an error message if invalid.

Overrides

PlatinaMessageBase.IsValid()

Implements

IDisposable