Class User

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

User details and settings

public class User : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

User

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()

Constructors

User()

Creates a new instance of this class

public User()

Properties

Active

The value indicates whether the user is active or not.

public bool Active { get; set; }

Property Value

Type	Description
bool

DBName

The databasename of the user.

public string DBName { get; set; }

Property Value

Type	Description
string

DefaultWebBasket

Default Web Basket

public string DefaultWebBasket { get; set; }

Property Value

Type	Description
string

DefaultWebBasketRelationLink

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

public string DefaultWebBasketRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

EMail

The email address of the user.

public string EMail { get; set; }

Property Value

Type	Description
string

ExternalId

The externalId of the user.

public string ExternalId { get; set; }

Property Value

Type	Description
string

ExternalIdp

The externalidp.

public string ExternalIdp { get; set; }

Property Value

Type	Description
string

ExternalIdpUserId

The externalidpuserid.

public string ExternalIdpUserId { get; set; }

Property Value

Type	Description
string

ExternalProvider

The externalProvider of the user.

public string ExternalProvider { get; set; }

Property Value

Type	Description
string

FirstName

The first name of the user.

public string FirstName { get; set; }

Property Value

Type	Description
string

GroupsRelationLink

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

public string GroupsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Id

The ID of the user.

public string Id { get; set; }

Property Value

Type	Description
string

LastName

The last name of the user.

public string LastName { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

The display name of the user.

public string Name { get; set; }

Property Value

Type	Description
string

NetworkId

The networkId of the user.

public string NetworkId { get; set; }

Property Value

Type	Description
string

OutOfOffice

Out of office settings

public OutOfOffice OutOfOffice { get; set; }

Property Value

Type	Description
OutOfOffice

RegionalSettings

Regional settings

public RegionalSettings RegionalSettings { get; set; }

Property Value

Type	Description
RegionalSettings

RolesRelationLink

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

public string RolesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Salutation

The salutation of the user.

public string Salutation { 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.

ShouldUpdateActive

The value indicates whether the active field of the user should be updated or not.

public bool ShouldUpdateActive { get; set; }

Property Value

Type	Description
bool

TwoStepVerificationEnabled

Indicates whether two step verification is enabled for the user.

public bool TwoStepVerificationEnabled { get; set; }

Property Value

Type	Description
bool

Methods

GetFileCabinetFromDefaultWebBasketRelation()

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

public FileCabinet GetFileCabinetFromDefaultWebBasketRelation()

Returns

Type	Description
FileCabinet	The content of the response.

GetFileCabinetFromDefaultWebBasketRelationAsync()

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

public Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromDefaultWebBasketRelationAsync()

Returns

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

Remarks

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

GetFileCabinetFromDefaultWebBasketRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromDefaultWebBasketRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetGroupsFromGroupsRelation()

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

public Groups GetGroupsFromGroupsRelation()

Returns

Type	Description
Groups	The content of the response.

GetGroupsFromGroupsRelationAsync()

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

public Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync()

Returns

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

Remarks

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

GetGroupsFromGroupsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetRolesFromRolesRelation()

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

public Roles GetRolesFromRolesRelation()

Returns

Type	Description
Roles	The content of the response.

GetRolesFromRolesRelationAsync()

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

public Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync()

Returns

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

Remarks

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

GetRolesFromRolesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetUserFromSelfRelation()

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

public User GetUserFromSelfRelation()

Returns

Type	Description
User	The content of the response.

GetUserFromSelfRelationAsync()

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

public Task<DeserializedHttpResponse<User>> GetUserFromSelfRelationAsync()

Returns

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

Remarks

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

GetUserFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<User>> GetUserFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToSelfRelationForUser(User)

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

public User PostToSelfRelationForUser(User dataToSend)

Parameters

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

Returns

Type	Description
User	The content of the response.

PostToSelfRelationForUserAsync(User)

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

public Task<DeserializedHttpResponse<User>> PostToSelfRelationForUserAsync(User dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSelfRelationForUserAsync(CancellationToken, User)

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

public Task<DeserializedHttpResponse<User>> PostToSelfRelationForUserAsync(CancellationToken cancellationToken, User dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToGroupsRelationForString(AssignmentOperation)

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

public string PutToGroupsRelationForString(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.

PutToGroupsRelationForStringAsync(AssignmentOperation)

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

public Task<DeserializedHttpResponse<string>> PutToGroupsRelationForStringAsync(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 “groups”.

PutToGroupsRelationForStringAsync(CancellationToken, AssignmentOperation)

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

public Task<DeserializedHttpResponse<string>> PutToGroupsRelationForStringAsync(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 “groups”.

PutToRolesRelationForString(AssignmentOperation)

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

public string PutToRolesRelationForString(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.

PutToRolesRelationForStringAsync(AssignmentOperation)

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

public Task<DeserializedHttpResponse<string>> PutToRolesRelationForStringAsync(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 “roles”.

PutToRolesRelationForStringAsync(CancellationToken, AssignmentOperation)

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

public Task<DeserializedHttpResponse<string>> PutToRolesRelationForStringAsync(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 “roles”.

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.