Class CheckOutResult
Result from a checkout. Contains link where document can be downloaded
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class CheckOutResult : IRelationsWithProxy
Properties
ContentRelationLink
Gets the Uri of the link for the relation “content”.
Declaration
public string ContentRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “content” if it exists, or
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
Methods
GetStreamFromContentRelation()
Calls the HTTP Get method on the link for the relation “content”.
Declaration
public System.IO.Stream GetStreamFromContentRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromContentRelationAsync()
Calls the HTTP Get method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync()
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 “content”.
GetStreamFromContentRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “content” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync(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 “content”.
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.