Class ExtendedControllerOperations

Operations available for controllers of the task.

Inheritance

System.Object

ExtendedControllerOperations

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class ExtendedControllerOperations : IRelationsWithProxy

Properties

InstanceRelationLink

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

Declaration

public string InstanceRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Methods

DeleteInstanceRelation()

Calls the HTTP Delete method on the link for the relation “instance”.

Declaration

public string DeleteInstanceRelation()

Returns

Type	Description
System.String	The content of the response.

DeleteInstanceRelationAsync()

Calls the HTTP Delete method on the link for the relation “instance” asynchronously.

Declaration

public Task<DeserializedHttpResponse<string>> DeleteInstanceRelationAsync()

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 “instance”.

DeleteInstanceRelationAsync(CancellationToken)

Calls the HTTP Delete method on the link for the relation “instance” asynchronously.

Declaration

public Task<DeserializedHttpResponse<string>> DeleteInstanceRelationAsync(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.String>>	A task which runs the request.

Remarks

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

GetStreamFromInstanceRelation()

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

Declaration

public Stream GetStreamFromInstanceRelation()

Returns

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

GetStreamFromInstanceRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<Stream>> GetStreamFromInstanceRelationAsync()

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 “instance”.

GetStreamFromInstanceRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<Stream>> GetStreamFromInstanceRelationAsync(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 “instance”.

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.