Class TrashBinTableRow
Defines a row of the table result from document query
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class TrashBinTableRow : IRelationsWithProxy
Properties
AnnotationAsSvgRelationLink
Gets the Uri of the link for the relation “annotationAsSvg”.
Declaration
public string AnnotationAsSvgRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “annotationAsSvg” if it exists, or
DocumentRelationLink
Gets the Uri of the link for the relation “document”.
Declaration
public string DocumentRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “document” if it exists, or
Id
Id of the trashed document represented by the current row.
Declaration
public string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Items
Declaration
public List<object> Items { get; set; }
Property Value
Type | Description |
---|---|
List<System.Object> |
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
LowQualityImageRelationLink
Gets the Uri of the link for the relation “lowQualityImage”.
Declaration
public string LowQualityImageRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “lowQualityImage” if it exists, or
Methods
GetDocumentFromDocumentRelation()
Calls the HTTP Get method on the link for the relation “document”.
Declaration
public Document GetDocumentFromDocumentRelation()
Returns
Type | Description |
---|---|
Document | The content of the response. |
GetDocumentFromDocumentRelationAsync()
Calls the HTTP Get method on the link for the relation “document” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromDocumentRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> | A task which runs the request. |
Remarks
This method follows the link for the relation “document”.
GetDocumentFromDocumentRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “document” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromDocumentRelationAsync(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<Document>> | A task which runs the request. |
Remarks
This method follows the link for the relation “document”.
GetStreamFromAnnotationAsSvgRelation()
Calls the HTTP Get method on the link for the relation “annotationAsSvg”.
Declaration
public System.IO.Stream GetStreamFromAnnotationAsSvgRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromAnnotationAsSvgRelationAsync()
Calls the HTTP Get method on the link for the relation “annotationAsSvg” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAnnotationAsSvgRelationAsync()
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 “annotationAsSvg”.
GetStreamFromAnnotationAsSvgRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “annotationAsSvg” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAnnotationAsSvgRelationAsync(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 “annotationAsSvg”.
GetStreamFromLowQualityImageRelation()
Calls the HTTP Get method on the link for the relation “lowQualityImage”.
Declaration
public System.IO.Stream GetStreamFromLowQualityImageRelation()
Returns
Type | Description |
---|---|
System.IO.Stream | The content of the response. |
GetStreamFromLowQualityImageRelationAsync()
Calls the HTTP Get method on the link for the relation “lowQualityImage” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLowQualityImageRelationAsync()
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 “lowQualityImage”.
GetStreamFromLowQualityImageRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “lowQualityImage” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromLowQualityImageRelationAsync(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 “lowQualityImage”.
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.