Class Notifications

A data stucture for managing notifications.

Inheritance

System.Object

Notifications

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Notifications : IRelationsWithProxy

Constructors

Notifications()

Creates a new instance of this class

Declaration

public Notifications()

Properties

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Notification

Collection of notifications.

Declaration

public List<Notification> Notification { get; set; }

Property Value

Type	Description
List<Notification>

SelfRelationLink

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

Declaration

public string SelfRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Timeout

Gets or sets the notifications timeout im milliseconds. A positive value lets the server wait for notifications for the specified amount of time. A value of 0 means that the server should respond immediately. A value of -1 indicates that the server should define the timeout.

Declaration

public int Timeout { get; set; }

Property Value

Type	Description
System.Int32

Methods

GetNotificationsFromSelfRelation()

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

Declaration

public Notifications GetNotificationsFromSelfRelation()

Returns

Type	Description
Notifications	The content of the response.

GetNotificationsFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Notifications>> GetNotificationsFromSelfRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Notifications>>	A task which runs the request.

Remarks

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

GetNotificationsFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Notifications>> GetNotificationsFromSelfRelationAsync(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<Notifications>>	A task which runs the request.

Remarks

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

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 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.