Class Organization
Definition for DocuWare organization.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class Organization : IRelationsWithProxy
Properties
AdditionalInfo
Declaration
public AdditionalOrganizationInfo AdditionalInfo { get; set; }
Property Value
Type | Description |
---|---|
AdditionalOrganizationInfo |
ConfigurationRights
List of the rights that the current user has for this cabinet.
Declaration
public List<ConfigurationRight> ConfigurationRights { get; set; }
Property Value
Type | Description |
---|---|
List<ConfigurationRight> |
ControllerWorkflowsRelationLink
Gets the Uri of the link for the relation “controllerWorkflows”.
Declaration
public string ControllerWorkflowsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “controllerWorkflows” if it exists, or
DialogsRelationLink
Gets the Uri of the link for the relation “dialogs”.
Declaration
public string DialogsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “dialogs” if it exists, or
FilecabinetsRelationLink
Gets the Uri of the link for the relation “filecabinets”.
Declaration
public string FilecabinetsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “filecabinets” if it exists, or
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
Guid
Guid of the organization
Declaration
public string Guid { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Id
Identity of the organization
Declaration
public string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
LoginTokenRelationLink
Gets the Uri of the link for the relation “loginToken”.
Declaration
public string LoginTokenRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “loginToken” if it exists, or
Name
Name of the organization
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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
SelectListInfosRelationLink
Gets the Uri of the link for the relation “selectListInfos”.
Declaration
public string SelectListInfosRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “selectListInfos” if it exists, or
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
SubstitutionListsRelationLink
Gets the Uri of the link for the relation “substitutionLists”.
Declaration
public string SubstitutionListsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “substitutionLists” if it exists, or
UserInfoRelationLink
Gets the Uri of the link for the relation “userInfo”.
Declaration
public string UserInfoRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “userInfo” if it exists, or
UsersRelationLink
Gets the Uri of the link for the relation “users”.
Declaration
public string UsersRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “users” if it exists, or
WorkflowRequestsRelationLink
Gets the Uri of the link for the relation “workflowRequests”.
Declaration
public string WorkflowRequestsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “workflowRequests” if it exists, or
WorkflowsRelationLink
Gets the Uri of the link for the relation “workflows”.
Declaration
public string WorkflowsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “workflows” if it exists, or
Methods
GetDialogInfosFromDialogsRelation()
Calls the HTTP Get method on the link for the relation “dialogs”.
Declaration
public DialogInfos GetDialogInfosFromDialogsRelation()
Returns
Type | Description |
---|---|
DialogInfos | The content of the response. |
GetDialogInfosFromDialogsRelationAsync()
Calls the HTTP Get method on the link for the relation “dialogs” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> | A task which runs the request. |
Remarks
This method follows the link for the relation “dialogs”.
GetDialogInfosFromDialogsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “dialogs” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> GetDialogInfosFromDialogsRelationAsync(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<DialogInfos>> | A task which runs the request. |
Remarks
This method follows the link for the relation “dialogs”.
GetFileCabinetsFromFilecabinetsRelation()
Calls the HTTP Get method on the link for the relation “filecabinets”.
Declaration
public FileCabinets GetFileCabinetsFromFilecabinetsRelation()
Returns
Type | Description |
---|---|
FileCabinets | The content of the response. |
GetFileCabinetsFromFilecabinetsRelationAsync()
Calls the HTTP Get method on the link for the relation “filecabinets” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>> GetFileCabinetsFromFilecabinetsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>> | A task which runs the request. |
Remarks
This method follows the link for the relation “filecabinets”.
GetFileCabinetsFromFilecabinetsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “filecabinets” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinets>> GetFileCabinetsFromFilecabinetsRelationAsync(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<FileCabinets>> | A task which runs the request. |
Remarks
This method follows the link for the relation “filecabinets”.
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”.
GetOrganizationFromSelfRelation()
Calls the HTTP Get method on the link for the relation “self”.
Declaration
public Organization GetOrganizationFromSelfRelation()
Returns
Type | Description |
---|---|
Organization | The content of the response. |
GetOrganizationFromSelfRelationAsync()
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>> GetOrganizationFromSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
GetOrganizationFromSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Organization>> GetOrganizationFromSelfRelationAsync(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<Organization>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
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”.
GetSelectListInfosFromSelectListInfosRelation()
Calls the HTTP Get method on the link for the relation “selectListInfos”.
Declaration
public SelectListInfos GetSelectListInfosFromSelectListInfosRelation()
Returns
Type | Description |
---|---|
SelectListInfos | The content of the response. |
GetSelectListInfosFromSelectListInfosRelationAsync()
Calls the HTTP Get method on the link for the relation “selectListInfos” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>> GetSelectListInfosFromSelectListInfosRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>> | A task which runs the request. |
Remarks
This method follows the link for the relation “selectListInfos”.
GetSelectListInfosFromSelectListInfosRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “selectListInfos” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListInfos>> GetSelectListInfosFromSelectListInfosRelationAsync(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<SelectListInfos>> | A task which runs the request. |
Remarks
This method follows the link for the relation “selectListInfos”.
GetSubstitutionListsFromSubstitutionListsRelation()
Calls the HTTP Get method on the link for the relation “substitutionLists”.
Declaration
public SubstitutionLists GetSubstitutionListsFromSubstitutionListsRelation()
Returns
Type | Description |
---|---|
SubstitutionLists | The content of the response. |
GetSubstitutionListsFromSubstitutionListsRelationAsync()
Calls the HTTP Get method on the link for the relation “substitutionLists” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>> GetSubstitutionListsFromSubstitutionListsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>> | A task which runs the request. |
Remarks
This method follows the link for the relation “substitutionLists”.
GetSubstitutionListsFromSubstitutionListsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “substitutionLists” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SubstitutionLists>> GetSubstitutionListsFromSubstitutionListsRelationAsync(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<SubstitutionLists>> | A task which runs the request. |
Remarks
This method follows the link for the relation “substitutionLists”.
GetUserInfoFromUserInfoRelation()
Calls the HTTP Get method on the link for the relation “userInfo”.
Declaration
public UserInfo GetUserInfoFromUserInfoRelation()
Returns
Type | Description |
---|---|
UserInfo | The content of the response. |
GetUserInfoFromUserInfoRelationAsync()
Calls the HTTP Get method on the link for the relation “userInfo” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>> GetUserInfoFromUserInfoRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>> | A task which runs the request. |
Remarks
This method follows the link for the relation “userInfo”.
GetUserInfoFromUserInfoRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “userInfo” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<UserInfo>> GetUserInfoFromUserInfoRelationAsync(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<UserInfo>> | A task which runs the request. |
Remarks
This method follows the link for the relation “userInfo”.
GetUsersFromUsersRelation()
Calls the HTTP Get method on the link for the relation “users”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> | A task which runs the request. |
Remarks
This method follows the link for the relation “users”.
GetUsersFromUsersRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “users” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Users>> GetUsersFromUsersRelationAsync(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<Users>> | A task which runs the request. |
Remarks
This method follows the link for the relation “users”.
GetWorkflowRequestsFromWorkflowRequestsRelation()
Calls the HTTP Get method on the link for the relation “workflowRequests”.
Declaration
public WorkflowRequests GetWorkflowRequestsFromWorkflowRequestsRelation()
Returns
Type | Description |
---|---|
WorkflowRequests | The content of the response. |
GetWorkflowRequestsFromWorkflowRequestsRelationAsync()
Calls the HTTP Get method on the link for the relation “workflowRequests” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>> GetWorkflowRequestsFromWorkflowRequestsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>> | A task which runs the request. |
Remarks
This method follows the link for the relation “workflowRequests”.
GetWorkflowRequestsFromWorkflowRequestsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “workflowRequests” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowRequests>> GetWorkflowRequestsFromWorkflowRequestsRelationAsync(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<WorkflowRequests>> | A task which runs the request. |
Remarks
This method follows the link for the relation “workflowRequests”.
GetWorkflowsFromControllerWorkflowsRelation()
Calls the HTTP Get method on the link for the relation “controllerWorkflows”.
Declaration
public Workflows GetWorkflowsFromControllerWorkflowsRelation()
Returns
Type | Description |
---|---|
Workflows | The content of the response. |
GetWorkflowsFromControllerWorkflowsRelationAsync()
Calls the HTTP Get method on the link for the relation “controllerWorkflows” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromControllerWorkflowsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> | A task which runs the request. |
Remarks
This method follows the link for the relation “controllerWorkflows”.
GetWorkflowsFromControllerWorkflowsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “controllerWorkflows” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromControllerWorkflowsRelationAsync(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<Workflows>> | A task which runs the request. |
Remarks
This method follows the link for the relation “controllerWorkflows”.
GetWorkflowsFromWorkflowsRelation()
Calls the HTTP Get method on the link for the relation “workflows”.
Declaration
public Workflows GetWorkflowsFromWorkflowsRelation()
Returns
Type | Description |
---|---|
Workflows | The content of the response. |
GetWorkflowsFromWorkflowsRelationAsync()
Calls the HTTP Get method on the link for the relation “workflows” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> | A task which runs the request. |
Remarks
This method follows the link for the relation “workflows”.
GetWorkflowsFromWorkflowsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “workflows” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowsRelationAsync(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<Workflows>> | A task which runs the request. |
Remarks
This method follows the link for the relation “workflows”.
PostToDialogsRelationForDialogInfos(RequestDialogQuery)
Calls the HTTP Post method on the link for the relation “dialogs”.
Declaration
public DialogInfos PostToDialogsRelationForDialogInfos(RequestDialogQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
RequestDialogQuery | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
DialogInfos | The content of the response. |
PostToDialogsRelationForDialogInfosAsync(RequestDialogQuery)
Calls the HTTP Post method on the link for the relation “dialogs” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> PostToDialogsRelationForDialogInfosAsync(RequestDialogQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
RequestDialogQuery | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> | A task which runs the request. |
Remarks
This method follows the link for the relation “dialogs”.
PostToDialogsRelationForDialogInfosAsync(System.Threading.CancellationToken, RequestDialogQuery)
Calls the HTTP Post method on the link for the relation “dialogs” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> PostToDialogsRelationForDialogInfosAsync(System.Threading.CancellationToken cancellationToken, RequestDialogQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
RequestDialogQuery | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DialogInfos>> | A task which runs the request. |
Remarks
This method follows the link for the relation “dialogs”.
PostToLoginTokenRelationForString(TokenDescription)
Calls the HTTP Post method on the link for the relation “loginToken”.
Declaration
public string PostToLoginTokenRelationForString(TokenDescription dataToSend)
Parameters
Type | Name | Description |
---|---|---|
TokenDescription | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.String | The content of the response. |
PostToLoginTokenRelationForStringAsync(TokenDescription)
Calls the HTTP Post method on the link for the relation “loginToken” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLoginTokenRelationForStringAsync(TokenDescription dataToSend)
Parameters
Type | Name | Description |
---|---|---|
TokenDescription | 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 “loginToken”.
PostToLoginTokenRelationForStringAsync(System.Threading.CancellationToken, TokenDescription)
Calls the HTTP Post method on the link for the relation “loginToken” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLoginTokenRelationForStringAsync(System.Threading.CancellationToken cancellationToken, TokenDescription dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
TokenDescription | 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 “loginToken”.
PostToUserInfoRelationForUser(NewUser)
Calls the HTTP Post method on the link for the relation “userInfo”.
Declaration
public User PostToUserInfoRelationForUser(NewUser dataToSend)
Parameters
Type | Name | Description |
---|---|---|
NewUser | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
User | The content of the response. |
PostToUserInfoRelationForUser(User)
Calls the HTTP Post method on the link for the relation “userInfo”.
Declaration
public User PostToUserInfoRelationForUser(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. |
PostToUserInfoRelationForUserAsync(NewUser)
Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(NewUser dataToSend)
Parameters
Type | Name | Description |
---|---|---|
NewUser | 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 “userInfo”.
PostToUserInfoRelationForUserAsync(User)
Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(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 “userInfo”.
PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken, NewUser)
Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken cancellationToken, NewUser dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
NewUser | 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 “userInfo”.
PostToUserInfoRelationForUserAsync(System.Threading.CancellationToken, User)
Calls the HTTP Post method on the link for the relation “userInfo” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<User>> PostToUserInfoRelationForUserAsync(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 “userInfo”.
PostToWorkflowRequestsRelationForString(RequestSettings)
Calls the HTTP Post method on the link for the relation “workflowRequests”.
Declaration
public string PostToWorkflowRequestsRelationForString(RequestSettings dataToSend)
Parameters
Type | Name | Description |
---|---|---|
RequestSettings | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.String | The content of the response. |
PostToWorkflowRequestsRelationForStringAsync(RequestSettings)
Calls the HTTP Post method on the link for the relation “workflowRequests” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToWorkflowRequestsRelationForStringAsync(RequestSettings dataToSend)
Parameters
Type | Name | Description |
---|---|---|
RequestSettings | 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 “workflowRequests”.
PostToWorkflowRequestsRelationForStringAsync(System.Threading.CancellationToken, RequestSettings)
Calls the HTTP Post method on the link for the relation “workflowRequests” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToWorkflowRequestsRelationForStringAsync(System.Threading.CancellationToken cancellationToken, RequestSettings dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
RequestSettings | 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 “workflowRequests”.
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 |
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.