Show / Hide Table of Contents

    Class User

    User details and settings

    Inheritance
    System.Object
    User
    Namespace: DocuWare.Platform.ServerClient
    Assembly: DocuWare.Platform.ServerClient.dll
    Syntax
    public class User : IRelationsWithProxy

    Constructors

    User()

    Creates a new instance of this class

    Declaration
    public User()

    Properties

    Active

    The value indicates whether the user is active or not.

    Declaration
    public bool Active { get; set; }
    Property Value
    Type Description
    System.Boolean

    DBName

    The databasename of the user.

    Declaration
    public string DBName { get; set; }
    Property Value
    Type Description
    System.String

    DefaultWebBasket

    Default Web Basket

    Declaration
    public string DefaultWebBasket { get; set; }
    Property Value
    Type Description
    System.String

    DefaultWebBasketRelationLink

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

    Declaration
    public string DefaultWebBasketRelationLink { get; }
    Property Value
    Type Description
    System.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.

    Declaration
    public string EMail { get; set; }
    Property Value
    Type Description
    System.String

    FirstName

    The first name of the user.

    Declaration
    public string FirstName { get; set; }
    Property Value
    Type Description
    System.String

    GroupsRelationLink

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

    Declaration
    public string GroupsRelationLink { get; }
    Property Value
    Type Description
    System.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.

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    System.String

    LastName

    The last name of the user.

    Declaration
    public string LastName { get; set; }
    Property Value
    Type Description
    System.String

    Links

    Declaration
    public Link[] Links { get; set; }
    Property Value
    Type Description
    Link[]

    Name

    The display name of the user.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    System.String

    NetworkId

    The networkId of the user.

    Declaration
    public string NetworkId { get; set; }
    Property Value
    Type Description
    System.String

    OutOfOffice

    Out of office settings

    Declaration
    public OutOfOffice OutOfOffice { get; set; }
    Property Value
    Type Description
    OutOfOffice

    RegionalSettings

    Regional settings

    Declaration
    public RegionalSettings RegionalSettings { get; set; }
    Property Value
    Type Description
    RegionalSettings

    RolesRelationLink

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

    Declaration
    public string RolesRelationLink { get; }
    Property Value
    Type Description
    System.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.

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

    Methods

    GetFileCabinetFromDefaultWebBasketRelation()

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

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromDefaultWebBasketRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>>

    A task which runs the request.

    Remarks

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

    GetFileCabinetFromDefaultWebBasketRelationAsync(System.Threading.CancellationToken)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromDefaultWebBasketRelationAsync(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<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”.

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>>

    A task which runs the request.

    Remarks

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

    GetGroupsFromGroupsRelationAsync(System.Threading.CancellationToken)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<Groups>> GetGroupsFromGroupsRelationAsync(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<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”.

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>>

    A task which runs the request.

    Remarks

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

    GetRolesFromRolesRelationAsync(System.Threading.CancellationToken)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<Roles>> GetRolesFromRolesRelationAsync(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<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”.

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> GetUserFromSelfRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<User>>

    A task which runs the request.

    Remarks

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

    GetUserFromSelfRelationAsync(System.Threading.CancellationToken)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> GetUserFromSelfRelationAsync(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<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”.

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

    Declaration
    public System.Threading.Tasks.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
    System.Threading.Tasks.Task<DeserializedHttpResponse<User>>

    A task which runs the request.

    Remarks

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

    PostToSelfRelationForUserAsync(System.Threading.CancellationToken, User)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToSelfRelationForUserAsync(System.Threading.CancellationToken cancellationToken, User dataToSend)
    Parameters
    Type Name Description
    System.Threading.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
    System.Threading.Tasks.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”.

    Declaration
    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
    System.String

    The content of the response.

    PutToGroupsRelationForStringAsync(AssignmentOperation)

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

    Declaration
    public System.Threading.Tasks.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
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

    A task which runs the request.

    Remarks

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

    PutToGroupsRelationForStringAsync(System.Threading.CancellationToken, AssignmentOperation)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToGroupsRelationForStringAsync(System.Threading.CancellationToken cancellationToken, AssignmentOperation dataToSend)
    Parameters
    Type Name Description
    System.Threading.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
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.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”.

    Declaration
    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
    System.String

    The content of the response.

    PutToRolesRelationForStringAsync(AssignmentOperation)

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

    Declaration
    public System.Threading.Tasks.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
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

    A task which runs the request.

    Remarks

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

    PutToRolesRelationForStringAsync(System.Threading.CancellationToken, AssignmentOperation)

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

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToRolesRelationForStringAsync(System.Threading.CancellationToken cancellationToken, AssignmentOperation dataToSend)
    Parameters
    Type Name Description
    System.Threading.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
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.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.

    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.

    About Us Contact Imprint Terms Data privacy
    © 2024 DocuWare Corporation powered by DocFX Back to top