Class BpwBaseDocument

Structure, describing the rights for specific document

Inheritance

System.Object

BpwBaseDocument

BpwDocument

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class BpwBaseDocument : IRelationsWithProxy

Constructors

BpwBaseDocument()

Creates a new instance of this class

Declaration

public BpwBaseDocument()

Properties

DocId

Declaration

public int DocId { get; set; }

Property Value

Type	Description
System.Int32

Fields

Declaration

public List<DocumentIndexField> Fields { get; set; }

Property Value

Type	Description
List<DocumentIndexField>

FileCabinetId

Declaration

public string FileCabinetId { get; set; }

Property Value

Type	Description
System.String

FirstSectionId

Declaration

public string FirstSectionId { get; set; }

Property Value

Type	Description
System.String

Flags

Declaration

public DocumentFlags Flags { get; set; }

Property Value

Type	Description
DocumentFlags

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

RightsRelationLink

Gets the Uri of the link for the relation “rights”.

Declaration

public string RightsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “rights” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

SectionCount

Declaration

public int SectionCount { get; set; }

Property Value

Type	Description
System.Int32

ThumbnailRelationLink

Gets the Uri of the link for the relation “thumbnail”.

Declaration

public string ThumbnailRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “thumbnail” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

VersionStatus

Version management status of the document

Declaration

public VersionManagementStatus VersionStatus { get; set; }

Property Value

Type	Description
VersionManagementStatus

Methods

GetStreamFromThumbnailRelation()

Calls the HTTP Get method on the link for the relation “thumbnail”.

Declaration

public System.IO.Stream GetStreamFromThumbnailRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromThumbnailRelationAsync()

Calls the HTTP Get method on the link for the relation “thumbnail” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “thumbnail”.

GetStreamFromThumbnailRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “thumbnail” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromThumbnailRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>	A task which runs the request.

Remarks

This method follows the link for the relation “thumbnail”.

PostToRightsRelationForSection(String, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “rights”.

Declaration

public Section PostToRightsRelationForSection(string requestedContentType, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.String	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Section	The content of the response.

PostToRightsRelationForSectionAsync(String, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “rights” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToRightsRelationForSectionAsync(string requestedContentType, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.String	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>>	A task which runs the request.

Remarks

This method follows the link for the relation “rights”.

PostToRightsRelationForSectionAsync(System.Threading.CancellationToken, String, System.IO.Stream)

Calls the HTTP Post method on the link for the relation “rights” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Section>> PostToRightsRelationForSectionAsync(System.Threading.CancellationToken cancellationToken, string requestedContentType, System.IO.Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.String	requestedContentType	Mime type of the requested body content, i.e. application/pdf.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Section>>	A task which runs the request.

Remarks

This method follows the link for the relation “rights”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.