Class Pages
Define a collection of pages
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class Pages : IRelationsWithProxy
Properties
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
NextBlockRelationLink
Gets the Uri of the link for the relation “nextBlock”.
Declaration
public string NextBlockRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “nextBlock” if it exists, or
Page
A collection of pages
Declaration
public List<Page> Page { get; set; }
Property Value
Type | Description |
---|---|
List<Page> |
Methods
GetPagesFromNextBlockRelation()
Calls the HTTP Get method on the link for the relation “nextBlock”.
Declaration
public Pages GetPagesFromNextBlockRelation()
Returns
Type | Description |
---|---|
Pages | The content of the response. |
GetPagesFromNextBlockRelationAsync()
Calls the HTTP Get method on the link for the relation “nextBlock” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Pages>> GetPagesFromNextBlockRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Pages>> | A task which runs the request. |
Remarks
This method follows the link for the relation “nextBlock”.
GetPagesFromNextBlockRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “nextBlock” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Pages>> GetPagesFromNextBlockRelationAsync(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<Pages>> | A task which runs the request. |
Remarks
This method follows the link for the relation “nextBlock”.
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.