Class Group

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Defines a DocuWare group

public class Group : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Group

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Active

Is group active flag.

public bool Active { get; set; }

Property Value

Type	Description
bool

Id

The role id.

public string Id { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

The name of the group.

public string Name { get; set; }

Property Value

Type	Description
string

SelfRelationLink

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

public string SelfRelationLink { get; }

Property Value

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

UsersRelationLink

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

public string UsersRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Methods

GetGroupFromSelfRelation()

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

public Group GetGroupFromSelfRelation()

Returns

Type	Description
Group	The content of the response.

GetGroupFromSelfRelationAsync()

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

public Task<DeserializedHttpResponse<Group>> GetGroupFromSelfRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Group>>	A task which runs the request.

Remarks

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

GetGroupFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Group>> GetGroupFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<Group>>	A task which runs the request.

Remarks

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

GetUsersFromUsersRelation()

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

public Users GetUsersFromUsersRelation()

Returns

Type	Description
Users	The content of the response.

GetUsersFromUsersRelationAsync()

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

public Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Users>>	A task which runs the request.

Remarks

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

GetUsersFromUsersRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<Users>>	A task which runs the request.

Remarks

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

PutToUsersRelationForString(AssignmentOperation)

Calls the HTTP Put method on the link for the relation “users”.

public string PutToUsersRelationForString(AssignmentOperation dataToSend)

Parameters

Type	Name	Description
AssignmentOperation	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
string	The content of the response.

PutToUsersRelationForStringAsync(AssignmentOperation)

Calls the HTTP Put method on the link for the relation “users” asynchronously.

public Task<DeserializedHttpResponse<string>> PutToUsersRelationForStringAsync(AssignmentOperation dataToSend)

Parameters

Type	Name	Description
AssignmentOperation	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

PutToUsersRelationForStringAsync(CancellationToken, AssignmentOperation)

Calls the HTTP Put method on the link for the relation “users” asynchronously.

public Task<DeserializedHttpResponse<string>> PutToUsersRelationForStringAsync(CancellationToken cancellationToken, AssignmentOperation dataToSend)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.
AssignmentOperation	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
Task<DeserializedHttpResponse<string>>	A task which runs the request.

Remarks

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

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The 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.