Class UpdateWorkingDocumentRequest

Message to be sent to system when updating a work document.

Inheritance

object

PlatinaMessageBase

CustomRequestHeaderMessageBase

UpdateWorkingDocumentRequest

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.MessageContracts.DocumentManagement

Syntax

[MessageContract]
public class UpdateWorkingDocumentRequest : CustomRequestHeaderMessageBase, IDisposable

Properties

Description

The description of object.

Declaration

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

Property Value

Type	Description
string	The description of object.

Extension

The extension of a work document to be updated.

Declaration

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

Property Value

Type	Description
string	The extension of a work document to be updated.

Remarks

The extension should not include the ".".

FileContentLength

The number of byte of the document to be uploaded.

Declaration

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

Property Value

Type	Description
long	The unique identifier of a work document to be updated.

Remarks

If set to 0, file content will not updated.

PropID

The unique identifier of the object.

Declaration

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

Property Value

Type	Description
int	[required] The unique identifier of the object.

Stream

The stream of a work document to be updated.

Declaration

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

Property Value

Type	Description
Stream	The stream of a work document to be updated.

Remarks

Is related to the FileContentLength

Title

The title of the object.

Declaration

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

Property Value

Type	Description
string	The title of the object.

Methods

Dispose()

Dispose message

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