Class ExtendedUserOperations

Operations available for common users of the task.

Inheritance

System.Object

ExtendedUserOperations

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class ExtendedUserOperations : IRelationsWithProxy

Properties

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

ReadStatusRelationLink

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

Declaration

public string ReadStatusRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “readStatus” 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.

Methods

PutToReadStatusRelationForString(Stream)

Calls the HTTP Put method on the link for the relation “readStatus”.

Declaration

public string PutToReadStatusRelationForString(Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.String	The content of the response.

PutToReadStatusRelationForStringAsync(Stream)

Calls the HTTP Put method on the link for the relation “readStatus” asynchronously.

Declaration

public Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(Stream dataToSend)

Parameters

Type	Name	Description
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PutToReadStatusRelationForStringAsync(CancellationToken, Stream)

Calls the HTTP Put method on the link for the relation “readStatus” asynchronously.

Declaration

public Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(CancellationToken cancellationToken, Stream dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.IO.Stream	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

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 System.Net.Http.HttpClient 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.