Class Role

Defines a DocuWare role

Inheritance

System.Object

Role

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Role : IRelationsWithProxy

Constructors

Role()

Creates a new instance of this class

Declaration

public Role()

Properties

Active

Is role active flag.

Declaration

public bool Active { get; set; }

Property Value

Type	Description
System.Boolean

Id

The role id.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

The name of the user.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

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.

Type

Type of role.

Declaration

public RoleTypes Type { get; set; }

Property Value

Type	Description
RoleTypes

Methods

GetRoleFromSelfRelation()

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

Declaration

public Role GetRoleFromSelfRelation()

Returns

Type	Description
Role	The content of the response.

GetRoleFromSelfRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<Role>> GetRoleFromSelfRelationAsync()

Returns

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

Remarks

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

GetRoleFromSelfRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<Role>> GetRoleFromSelfRelationAsync(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<Role>>	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 System.Net.Http.HttpClient 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.