Class ExtendedUserOperations
Operations available for common users of the task.
Inheritance
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
Methods
PutToReadStatusRelationForString(System.IO.Stream)
Calls the HTTP Put method on the link for the relation “readStatus”.
Declaration
public string PutToReadStatusRelationForString(System.IO.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(System.IO.Stream)
Calls the HTTP Put method on the link for the relation “readStatus” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(System.IO.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(System.Threading.CancellationToken, System.IO.Stream)
Calls the HTTP Put method on the link for the relation “readStatus” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(System.Threading.CancellationToken cancellationToken, System.IO.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 |
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.