User Class

User Class

User details and settings

Inheritance Hierarchy

SystemObject
DocuWare.Platform.ServerClientUser

Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient (in DocuWare.Platform.ServerClient.dll) Version: Version 6.9

Syntax

Copy

[XmlTypeAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform")]
[XmlRootAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform", 
	IsNullable = false)]
public class User : IRelationsWithProxy, IRelations, IHttpClientProxy

The User type exposes the following members.

Constructors

	Name	Description
	User	Creates a new instance of this class

Top

Properties

	Name	Description
	Active	The value indicates whether the user is active or not.
	DBName	The databasename of the user.
	DefaultWebBasket	Default Web Basket
	DefaultWebBasketRelationLink	Gets the Uri of the link for the relation “defaultWebBasket”.
	EMail	The email address of the user.
	GroupsRelationLink	Gets the Uri of the link for the relation “groups”.
	Id	The ID of the user.
	Links
	Name	The display name of the user.
	NetworkId	The networkId of the user.
	OutOfOffice	Out of office settings
	RegionalSettings	Regional settings
	RolesRelationLink	Gets the Uri of the link for the relation “roles”.
	SelfRelationLink	Gets the Uri of the link for the relation “self”.

Top

Methods

	Name	Description
	GetFileCabinetFromDefaultWebBasketRelation	Calls the HTTP Get method on the link for the relation “defaultWebBasket”.
	GetFileCabinetFromDefaultWebBasketRelationAsync	Calls the HTTP Get method on the link for the relation “defaultWebBasket” asynchronously.
	GetFileCabinetFromDefaultWebBasketRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “defaultWebBasket” asynchronously.
	GetGroupsFromGroupsRelation	Calls the HTTP Get method on the link for the relation “groups”.
	GetGroupsFromGroupsRelationAsync	Calls the HTTP Get method on the link for the relation “groups” asynchronously.
	GetGroupsFromGroupsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “groups” asynchronously.
	GetRolesFromRolesRelation	Calls the HTTP Get method on the link for the relation “roles”.
	GetRolesFromRolesRelationAsync	Calls the HTTP Get method on the link for the relation “roles” asynchronously.
	GetRolesFromRolesRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “roles” asynchronously.
	GetUserFromSelfRelation	Calls the HTTP Get method on the link for the relation “self”.
	GetUserFromSelfRelationAsync	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetUserFromSelfRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	PostToSelfRelationForUser	Calls the HTTP Post method on the link for the relation “self”.
	PostToSelfRelationForUserAsync(User)	Calls the HTTP Post method on the link for the relation “self” asynchronously.
	PostToSelfRelationForUserAsync(CancellationToken, User)	Calls the HTTP Post method on the link for the relation “self” asynchronously.
	PutToGroupsRelationForString	Calls the HTTP Put method on the link for the relation “groups”.
	PutToGroupsRelationForStringAsync(AssignmentOperation)	Calls the HTTP Put method on the link for the relation “groups” asynchronously.
	PutToGroupsRelationForStringAsync(CancellationToken, AssignmentOperation)	Calls the HTTP Put method on the link for the relation “groups” asynchronously.
	PutToRolesRelationForString	Calls the HTTP Put method on the link for the relation “roles”.
	PutToRolesRelationForStringAsync(AssignmentOperation)	Calls the HTTP Put method on the link for the relation “roles” asynchronously.
	PutToRolesRelationForStringAsync(CancellationToken, AssignmentOperation)	Calls the HTTP Put method on the link for the relation “roles” asynchronously.
	SetProxy	Sets the HTTP communication proxy which is used in further HTTP communication.

Top

Extension Methods

	Name	Description
	DeleteTResponse(String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetBaseUri	Gets the base URI of the specified relations instance. (Defined by RelationsWithProxyExtensions.)
	GetLink	Gets the link by its name. (Defined by RelationExtension.)
	GetRelationUri	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	GetRelationUriOrThrow	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	HasRelationUri	Determines whether the specified link exists. (Defined by RelationExtension.)
	SendTResponse(HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)

Top

Explicit Interface Implementations

	Name	Description
	IHttpClientProxyProxy

Top

Remarks

Reference

DocuWare.Platform.ServerClient Namespace

Send comments on this topic to DocuWare