Class ServiceConnection

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Encapsulates a connection to the platform.

public class ServiceConnection

Inheritance

object

ServiceConnection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

CheckoutCheckinBase.CheckInFromFileSystemAsync(ServiceConnection, IFileUploadInfo, CheckInActionParameters)

CheckoutCheckinBase.ChunkCheckInFromFileSystemAsync(ServiceConnection, IFileUploadInfo, CheckInActionParameters, int)

EasyCheckoutCheckinExtensionsBase.EasyCheckInFromFileSystemAsync(ServiceConnection, IFileUploadInfo)

EasyCheckoutCheckinExtensionsBase.EasyCheckInFromFileSystemAsync(ServiceConnection, IFileUploadInfo, CheckInActionParameters)

EasyCheckoutCheckinExtensionsBase.EasyCheckOutToFileSystemAsync(ServiceConnection, string, int)

EasyFileUploadExtensionsBase.EasyUploadDocumentAsync(ServiceConnection, FileCabinet, string, IFileUploadInfo[], Document)

FileCabinetExtensionsBase.ChunkUploadDocumentAsync(ServiceConnection, FileCabinet, string, IFileUploadInfo[], Document, int)

FileCabinetExtensionsBase.UploadDocumentAsync(ServiceConnection, FileCabinet, Document, IFileUploadInfo[], string)

SchemaExtensions.CreateUserDefinedSearchOperation(ServiceConnection, string, FunctionExpressionQuery, string[], string[], int?, int?)

SchemaExtensions.DeleteFromDocumentDeleteForStringAsync(ServiceConnection, int, string)

SchemaExtensions.DeleteFromDocumentDeleteForStringAsync(ServiceConnection, CancellationToken, int, string)

SchemaExtensions.DeleteFromWorkflowInstanceForStringAsync(ServiceConnection, string, string)

SchemaExtensions.DeleteFromWorkflowInstanceForStringAsync(ServiceConnection, CancellationToken, string, string)

SchemaExtensions.GetFromAnnotationForAnnotationAsync(ServiceConnection, string, string, int)

SchemaExtensions.GetFromAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int)

SchemaExtensions.GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(ServiceConnection, string, string)

SchemaExtensions.GetFromAuditEventPropertiesForDocumentAuditEventInformationAsync(ServiceConnection, CancellationToken, string, string)

SchemaExtensions.GetFromClientSetupDataForXElementAsync(ServiceConnection, string, string, string)

SchemaExtensions.GetFromClientSetupDataForXElementAsync(ServiceConnection, CancellationToken, string, string, string)

SchemaExtensions.GetFromControllerWorkflowDecisionsForDecisionAsync(ServiceConnection, string, string, string, int, bool?, bool?)

SchemaExtensions.GetFromControllerWorkflowDecisionsForDecisionAsync(ServiceConnection, CancellationToken, string, string, string, int, bool?, bool?)

SchemaExtensions.GetFromControllerWorkflowForWorkflowAsync(ServiceConnection, string, bool?)

SchemaExtensions.GetFromControllerWorkflowForWorkflowAsync(ServiceConnection, CancellationToken, string, bool?)

SchemaExtensions.GetFromControllerWorkflowTaskForWorkflowTaskAsync(ServiceConnection, string, string, string, bool?, bool?, bool?)

SchemaExtensions.GetFromControllerWorkflowTaskForWorkflowTaskAsync(ServiceConnection, CancellationToken, string, string, string, bool?, bool?, bool?)

SchemaExtensions.GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(ServiceConnection, string)

SchemaExtensions.GetFromControllerWorkflowTasksCountForWorkflowTasksCountAsync(ServiceConnection, CancellationToken, string)

SchemaExtensions.GetFromControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, string, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.GetFromControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.GetFromControllerWorkflowsForWorkflowsAsync(ServiceConnection, bool?)

SchemaExtensions.GetFromControllerWorkflowsForWorkflowsAsync(ServiceConnection, CancellationToken, bool?)

SchemaExtensions.GetFromCountResultForCountResultAsync(ServiceConnection, string, string, string, int?)

SchemaExtensions.GetFromCountResultForCountResultAsync(ServiceConnection, CancellationToken, string, string, string, int?)

SchemaExtensions.GetFromCountTrashedDocumentsForCountResultAsync(ServiceConnection)

SchemaExtensions.GetFromDialogForDialogAsync(ServiceConnection, string, string, DialogTypes[])

SchemaExtensions.GetFromDialogForDialogAsync(ServiceConnection, CancellationToken, string, string, DialogTypes[])

SchemaExtensions.GetFromDialogsByFileCabinetForDialogInfosAsync(ServiceConnection, string, DialogTypes[])

SchemaExtensions.GetFromDialogsByFileCabinetForDialogInfosAsync(ServiceConnection, CancellationToken, string, DialogTypes[])

SchemaExtensions.GetFromDialogsForDialogInfosAsync(ServiceConnection, DialogTypes[])

SchemaExtensions.GetFromDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, CancellationToken, int, string)

SchemaExtensions.GetFromDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromDocumentAuditInformationForDocumentAuditInformationAsync(ServiceConnection, string, int, DateTime?, DateTime?, string, int?, int?, string, string, bool?)

SchemaExtensions.GetFromDocumentAuditInformationForDocumentAuditInformationAsync(ServiceConnection, CancellationToken, string, int, DateTime?, DateTime?, string, int?, int?, string, string, bool?)

SchemaExtensions.GetFromDocumentContentForStreamAsync(ServiceConnection, int, string, int[])

SchemaExtensions.GetFromDocumentDocumentLinksForDocumentLinksAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromDocumentDocumentLinksForDocumentLinksAsync(ServiceConnection, CancellationToken, int, string)

SchemaExtensions.GetFromDocumentForDocumentAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromDocumentForDocumentAsync(ServiceConnection, CancellationToken, int, string)

SchemaExtensions.GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string)

SchemaExtensions.GetFromDocumentLatestVersionForDocumentAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromDocumentTableFieldRowsForDocumentIndexFieldTableAsync(ServiceConnection, int, string, string, int?, int?)

SchemaExtensions.GetFromDocumentsFileDownloadForStreamAsync(ServiceConnection, int, string, FileDownloadType?, bool?, bool?, bool?, int[], int[])

SchemaExtensions.GetFromDocumentsFileDownloadForStreamAsync(ServiceConnection, CancellationToken, int, string, FileDownloadType?, bool?, bool?, bool?, int[], int[])

SchemaExtensions.GetFromDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, string, string[], string[], int?, int?, int?, string, bool?, string, bool?, bool?)

SchemaExtensions.GetFromDocumentsForDocumentsQueryResultAsync(ServiceConnection, CancellationToken, string, string, string[], string[], int?, int?, int?, string, bool?)

SchemaExtensions.GetFromFileCabinetForFileCabinetAsync(ServiceConnection, string)

SchemaExtensions.GetFromFileCabinetForFileCabinetAsync(ServiceConnection, CancellationToken, string)

SchemaExtensions.GetFromFileCabinetsForFileCabinetsAsync(ServiceConnection)

SchemaExtensions.GetFromFileCabinetsForFileCabinetsAsync(ServiceConnection, CancellationToken)

SchemaExtensions.GetFromFunctionExpressionForDocumentsQueryTableResultAsync(ServiceConnection, string, string[], string[], int?, int?)

SchemaExtensions.GetFromIntellixSuggestionsForSuggestionFieldsAsync(ServiceConnection, int, string, bool?)

SchemaExtensions.GetFromIntellixSuggestionsForSuggestionFieldsAsync(ServiceConnection, CancellationToken, int, string, bool?)

SchemaExtensions.GetFromMultiColSelectListForMultiColSelectListInfoAsync(ServiceConnection, string)

SchemaExtensions.GetFromMultiColSelectListForMultiColSelectListInfoAsync(ServiceConnection, CancellationToken, string)

SchemaExtensions.GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(ServiceConnection, string, int?, int?)

SchemaExtensions.GetFromMultiColSelectListValuesForMultiColSelectListValuesResultAsync(ServiceConnection, CancellationToken, string, int?, int?)

SchemaExtensions.GetFromMultiColSelectListsForMultiColSelectListInfosAsync(ServiceConnection)

SchemaExtensions.GetFromMultiColSelectListsForMultiColSelectListInfosAsync(ServiceConnection, CancellationToken)

SchemaExtensions.GetFromPagesBlockForPagesAsync(ServiceConnection, string, string, int?, int?, bool?, string, bool?)

SchemaExtensions.GetFromPagesBlockForPagesAsync(ServiceConnection, CancellationToken, string, string, int?, int?, bool?, string, bool?)

SchemaExtensions.GetFromQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, string, string[], string[], int?, int?, string, string, string, string, bool?, bool?, bool?)

SchemaExtensions.GetFromRequestTasksForRequestTasksAsync(ServiceConnection, int?, int?, string, string, string, string, bool?, bool?)

SchemaExtensions.GetFromRequestTasksForRequestTasksAsync(ServiceConnection, CancellationToken, int?, int?, string, string, string, string, bool?, bool?)

SchemaExtensions.GetFromSectionFileDownloadForStreamAsync(ServiceConnection, string, string, FileDownloadType?, bool?, bool?, bool?, bool?, int[])

SchemaExtensions.GetFromSectionForSectionAsync(ServiceConnection, string, string, string, bool?)

SchemaExtensions.GetFromSectionPageForPageAsync(ServiceConnection, string, string, int)

SchemaExtensions.GetFromSectionPositionsForWordSearchResultAsync(ServiceConnection, string, string, string, bool?, bool?, int?, int?, int?, bool?, bool?)

SchemaExtensions.GetFromSectionTextAnnotationForStringAsync(ServiceConnection, string, string, bool?)

SchemaExtensions.GetFromSectionTextshotForDocumentContentAsync(ServiceConnection, string, string, bool?)

SchemaExtensions.GetFromSectionTextshotPageForPageContentAsync(ServiceConnection, string, string, int, bool?, bool?)

SchemaExtensions.GetFromSectionsForSectionsAsync(ServiceConnection, int, string)

SchemaExtensions.GetFromSelectListForSelectListInfoAsync(ServiceConnection, string, string)

SchemaExtensions.GetFromSelectListForSelectListInfoAsync(ServiceConnection, CancellationToken, string, string)

SchemaExtensions.GetFromSelectListValuesForSelectListValuesResultAsync(ServiceConnection, string, int?, int?, string, string)

SchemaExtensions.GetFromSingleColumnSelectListValuesResultForSingleColumnSelectListValuesAsync(ServiceConnection, string, int?, int?, string, string)

SchemaExtensions.GetFromTasksCountForWorkflowTasksCountAsync(ServiceConnection, string)

SchemaExtensions.GetFromTasksCountForWorkflowTasksCountAsync(ServiceConnection, CancellationToken, string)

SchemaExtensions.GetFromTasksForWorkflowTasksAsync(ServiceConnection, string, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.GetFromTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.GetFromTextshotPreviewForStringAsync(ServiceConnection, int, string, string)

SchemaExtensions.GetFromTextshotPreviewForStringAsync(ServiceConnection, int, string, string, bool)

SchemaExtensions.GetFromTrashBinForTrashBinAsync(ServiceConnection)

SchemaExtensions.GetFromTrashedDocumentsForTrashBinDocumentsTableResultAsync(ServiceConnection, string, string[], int?, int?, bool?)

SchemaExtensions.GetFromUsersForUserByExternalIdAsync(ServiceConnection, string, string)

SchemaExtensions.GetFromUsersForUserByIdAsync(ServiceConnection, string)

SchemaExtensions.GetFromUsersForUserRolesAsync(ServiceConnection, string, bool?, string, string)

SchemaExtensions.GetFromUsersForUsersByRoleAsync(ServiceConnection, string, bool?)

SchemaExtensions.GetFromWorkflowDecisionsForDecisionAsync(ServiceConnection, string, string, string, int, bool?, bool?)

SchemaExtensions.GetFromWorkflowDecisionsForDecisionAsync(ServiceConnection, CancellationToken, string, string, string, int, bool?, bool?)

SchemaExtensions.GetFromWorkflowForWorkflowAsync(ServiceConnection, string, bool?)

SchemaExtensions.GetFromWorkflowForWorkflowAsync(ServiceConnection, CancellationToken, string, bool?)

SchemaExtensions.GetFromWorkflowInstanceForInstanceAsync(ServiceConnection, string, string)

SchemaExtensions.GetFromWorkflowInstanceForInstanceAsync(ServiceConnection, CancellationToken, string, string)

SchemaExtensions.GetFromWorkflowRequestTaskForRequestTaskAsync(ServiceConnection, string, string, bool?)

SchemaExtensions.GetFromWorkflowRequestTaskForRequestTaskAsync(ServiceConnection, CancellationToken, string, string, bool?)

SchemaExtensions.GetFromWorkflowTaskForWorkflowTaskAsync(ServiceConnection, string, string, string, bool?, bool?)

SchemaExtensions.GetFromWorkflowTaskForWorkflowTaskAsync(ServiceConnection, CancellationToken, string, string, string, bool?, bool?)

SchemaExtensions.GetFromWorkflowsForWorkflowsAsync(ServiceConnection, bool?)

SchemaExtensions.GetFromWorkflowsForWorkflowsAsync(ServiceConnection, CancellationToken, bool?)

SchemaExtensions.GetGroupFromGroupAsync(ServiceConnection, string)

SchemaExtensions.GetGroupFromGroupAsync(ServiceConnection, CancellationToken, string)

SchemaExtensions.GetGroupsFromGroupsQueryParamsAsync(ServiceConnection, bool?, string)

SchemaExtensions.GetRolesFromRolesQueryParamsAsync(ServiceConnection, bool?, string, string)

SchemaExtensions.GetUserGroupsFromUserGroupsQueryParamsAsync(ServiceConnection, string, bool?, string)

SchemaExtensions.GetUsersFromUsersQueryParamsAsync(ServiceConnection, bool?, string)

SchemaExtensions.PostFilterUsersFromUsersQueryAsync(ServiceConnection, UsersQuery)

SchemaExtensions.PostFromSectionTextshotForStringAsync(ServiceConnection, string, string)

SchemaExtensions.PostGroupFromCreateGroupAsync(ServiceConnection, Group)

SchemaExtensions.PostGroupFromCreateGroupAsync(ServiceConnection, CancellationToken, Group)

SchemaExtensions.PostGroupsFromGroupsQueryAsync(ServiceConnection, GroupsQuery)

SchemaExtensions.PostRolesFromRolesQueryAsync(ServiceConnection, RolesQuery)

SchemaExtensions.PostToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, Annotation)

SchemaExtensions.PostToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, AnnotationsPlacement)

SchemaExtensions.PostToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, Annotation)

SchemaExtensions.PostToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, AnnotationsPlacement)

SchemaExtensions.PostToArchiveDocumentForStreamAsync(ServiceConnection, string, int, ExportSettings)

SchemaExtensions.PostToAreValuesInSelectListForAreValuesInSelectListsResultAsync(ServiceConnection, string, SelectListValuesToCheck)

SchemaExtensions.PostToBatchDeleteForBatchDeleteResultAsync(ServiceConnection, BatchDeleteDocumentsSource)

SchemaExtensions.PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, string, BatchUpdateProcess, string[], string[])

SchemaExtensions.PostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, CancellationToken, string, string, BatchUpdateProcess, string[], string[])

SchemaExtensions.PostToBatchQueryUpdateFieldsOperationForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, BatchUpdateProcessData, string[], string[], string, int?)

SchemaExtensions.PostToBatchRestoreForBatchRestoreResultAsync(ServiceConnection, BatchRestoreDocumentsSource)

SchemaExtensions.PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, BatchAppendKeywordValues)

SchemaExtensions.PostToBatchUpdateFieldsForBatchUpdateIndexFieldsResultAsync(ServiceConnection, string, BatchUpdateProcess)

SchemaExtensions.PostToCheckinForDocumentAsync(ServiceConnection, int, string, MultipartFormDataContent)

SchemaExtensions.PostToCheckinForDocumentAsync(ServiceConnection, CancellationToken, int, string, MultipartFormDataContent)

SchemaExtensions.PostToCheckoutDocumentForCheckOutResultAsync(ServiceConnection, int, string, CheckOutToFileSystemInfo)

SchemaExtensions.PostToCheckoutDocumentForCheckOutResultAsync(ServiceConnection, CancellationToken, int, string, CheckOutToFileSystemInfo)

SchemaExtensions.PostToCheckoutForStreamAsync(ServiceConnection, int, string, CheckOutToFileSystemInfo)

SchemaExtensions.PostToCheckoutForStreamAsync(ServiceConnection, CancellationToken, int, string, CheckOutToFileSystemInfo)

SchemaExtensions.PostToClippedDocumentsForDocumentAsync(ServiceConnection, int, string, IntegerList, ContentMergeOperation?)

SchemaExtensions.PostToClippedDocumentsForDocumentAsync(ServiceConnection, CancellationToken, int, string, IntegerList, ContentMergeOperation?)

SchemaExtensions.PostToContentDivideForDocumentsQueryResultAsync(ServiceConnection, string, int, ContentDivideOperationInfo)

SchemaExtensions.PostToContentMergeForDocumentAsync(ServiceConnection, string, ContentMergeOperationInfo)

SchemaExtensions.PostToControllerWorkflowConfirmForStringAsync(ServiceConnection, string, string, string, int, ConfirmedData)

SchemaExtensions.PostToControllerWorkflowConfirmForStringAsync(ServiceConnection, CancellationToken, string, string, string, int, ConfirmedData)

SchemaExtensions.PostToControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.PostToControllerWorkflowTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.PostToCreatePermanentUrlForStringAsync(ServiceConnection, FormUrlEncodedContent, bool?)

SchemaExtensions.PostToCreatePermanentUrlForStringAsync(ServiceConnection, CancellationToken, FormUrlEncodedContent, bool?)

SchemaExtensions.PostToCreateUserDefinedSearchForDialogAsync(ServiceConnection, string, string, UserDefinedSearchInfo)

SchemaExtensions.PostToCreateUserDefinedSearchForDialogAsync(ServiceConnection, CancellationToken, string, string, UserDefinedSearchInfo)

SchemaExtensions.PostToDialogExpressionForDocumentsQueryResultAsync(ServiceConnection, string, string, DialogExpression, string[], string[], int?, int?)

SchemaExtensions.PostToDialogExpressionForDocumentsQueryResultAsync(ServiceConnection, CancellationToken, string, string, DialogExpression, string[], string[], int?, int?)

SchemaExtensions.PostToDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, int, string, DocumentAnnotationsPlacement)

SchemaExtensions.PostToDocumentAnnotationsForDocumentAnnotationsAsync(ServiceConnection, CancellationToken, int, string, DocumentAnnotationsPlacement)

SchemaExtensions.PostToDocumentAppendFilesForDocumentAsync(ServiceConnection, int, string, MultipartFormDataContent)

SchemaExtensions.PostToDocumentAppendFilesForDocumentAsync(ServiceConnection, CancellationToken, int, string, MultipartFormDataContent)

SchemaExtensions.PostToDocumentApplicationPropertiesForDocumentApplicationPropertiesAsync(ServiceConnection, int, string, DocumentApplicationProperties)

SchemaExtensions.PostToDocumentDeleteVersionHistoryForStringAsync(ServiceConnection, int, string)

SchemaExtensions.PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, DocumentIndexFields)

SchemaExtensions.PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, UpdateIndexFieldsInfo)

SchemaExtensions.PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, DocumentIndexFields)

SchemaExtensions.PostToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, UpdateIndexFieldsInfo)

SchemaExtensions.PostToDocumentRightsForRightsAsync(ServiceConnection, int, string, Rights)

SchemaExtensions.PostToDocumentRightsForRightsAsync(ServiceConnection, CancellationToken, int, string, Rights)

SchemaExtensions.PostToDocumentlessTriggerForStringAsync(ServiceConnection, string, DocumentlessTriggerData)

SchemaExtensions.PostToDocumentlessTriggerForStringAsync(ServiceConnection, CancellationToken, string, DocumentlessTriggerData)

SchemaExtensions.PostToExportForStreamAsync(ServiceConnection, string, ExportSettings, string, string[], string[])

SchemaExtensions.PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(ServiceConnection, string, SelectListExpression)

SchemaExtensions.PostToFieldValueStatisticsForFieldValueStatisticsResultAsync(ServiceConnection, CancellationToken, string, SelectListExpression)

SchemaExtensions.PostToFunctionExpressionForDocumentsQueryTableResultAsync(ServiceConnection, string, FunctionExpressionQuery, string[], string[], int?, int?)

SchemaExtensions.PostToImportDocumentForImportResultAsync(ServiceConnection, string, Stream)

SchemaExtensions.PostToImportDocumentForImportResultAsync(ServiceConnection, CancellationToken, string, Stream)

SchemaExtensions.PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(ServiceConnection, string, MultiColSelectListValuesQuery)

SchemaExtensions.PostToMultiColSelectListValuesWithQueryForMultiColSelectListValuesResultAsync(ServiceConnection, CancellationToken, string, MultiColSelectListValuesQuery)

SchemaExtensions.PostToMultiColumnSelectListValuesForSelectListValuesResultAsync(ServiceConnection, string, MultiColumnSelectListValuesQuery)

SchemaExtensions.PostToQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, DocumentLinkExpressionQuery, string, string[], string[], int?, int?, string, string, string, string, bool?, bool?, bool?)

SchemaExtensions.PostToQueryDocumentsForDocumentsQueryResultAsync(ServiceConnection, string, ResultListQuery, string, string[], string[], int?, int?, string, string, string, string, bool?, bool?, bool?)

SchemaExtensions.PostToQueryTrashedDocumentsForTrashBinDocumentsTableResultAsync(ServiceConnection, TrashBinQuery)

SchemaExtensions.PostToRequestTasksForRequestTasksAsync(ServiceConnection, TasksQuery, int?, int?, string, string, string, string, bool?, bool?)

SchemaExtensions.PostToRequestTasksForRequestTasksAsync(ServiceConnection, CancellationToken, TasksQuery, int?, int?, string, string, string, string, bool?, bool?)

SchemaExtensions.PostToRetrieveSequenceElementForSequenceResultAsync(ServiceConnection, string, SequenceRequest)

SchemaExtensions.PostToRetrieveSequenceElementForSequenceResultAsync(ServiceConnection, CancellationToken, string, SequenceRequest)

SchemaExtensions.PostToSectionPagesBlockResultForPagesAsync(ServiceConnection, string, string, PagesBlockQuery)

SchemaExtensions.PostToSectionStampBestPositionForDWPointAsync(ServiceConnection, string, string, int, StampFormFieldValues)

SchemaExtensions.PostToSectionStampForAnnotationAsync(ServiceConnection, string, string, int, StampPlacement)

SchemaExtensions.PostToSelectListExpressionForSelectListResultAsync(ServiceConnection, string, string, string, string, SelectListExpression)

SchemaExtensions.PostToSelectListExpressionForSelectListResultAsync(ServiceConnection, CancellationToken, string, string, string, string, SelectListExpression)

SchemaExtensions.PostToSelectListValuesForSingleColumnSelectListValuesAsync(ServiceConnection, string, SelectListValuesQuery)

SchemaExtensions.PostToTasksForWorkflowTasksAsync(ServiceConnection, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.PostToTasksForWorkflowTasksAsync(ServiceConnection, CancellationToken, string, TasksQuery, string[], int?, int?, string, string, string, bool?, bool?)

SchemaExtensions.PostToTransferForDocumentsQueryResultAsync(ServiceConnection, string, string, DocumentsTransferInfo)

SchemaExtensions.PostToTransferForDocumentsQueryResultAsync(ServiceConnection, string, string, FileCabinetTransferInfo)

SchemaExtensions.PostToUploadDocumentForDocumentAsync(ServiceConnection, string, Document, bool?, bool?, string, string, bool?)

SchemaExtensions.PostToUploadDocumentForDocumentAsync(ServiceConnection, string, InputDocument, bool?, bool?, string, string, bool?)

SchemaExtensions.PostToUploadDocumentForDocumentAsync(ServiceConnection, string, Stream, bool?, bool?, string, string, bool?)

SchemaExtensions.PostToUploadDocumentForDocumentAsync(ServiceConnection, CancellationToken, string, Document, bool?, bool?, string, string, bool?)

SchemaExtensions.PostToUploadDocumentForDocumentAsync(ServiceConnection, CancellationToken, string, Stream, bool?, bool?, string, string, bool?)

SchemaExtensions.PostToUsersForUserRolesAsync(ServiceConnection, UserRolesQuery, string, bool?, string, string)

SchemaExtensions.PostToUsersForUsersByRoleAsync(ServiceConnection, UsersByRole, string, bool?)

SchemaExtensions.PostToValidateUserForStringAsync(ServiceConnection, string, UserValidation)

SchemaExtensions.PostToValidateUserForStringAsync(ServiceConnection, CancellationToken, string, UserValidation)

SchemaExtensions.PostToWorkflowConfirmForStringAsync(ServiceConnection, string, string, string, int, ConfirmedData)

SchemaExtensions.PostToWorkflowConfirmForStringAsync(ServiceConnection, CancellationToken, string, string, string, int, ConfirmedData)

SchemaExtensions.PostUserGroupsFromUserGroupsQueryAsync(ServiceConnection, UserGroupsQuery)

SchemaExtensions.PutFromSectionTextshotForStringAsync(ServiceConnection, string, string)

SchemaExtensions.PutToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, Annotation)

SchemaExtensions.PutToAnnotationForAnnotationAsync(ServiceConnection, string, string, int, AnnotationsPlacement)

SchemaExtensions.PutToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, Annotation)

SchemaExtensions.PutToAnnotationForAnnotationAsync(ServiceConnection, CancellationToken, string, string, int, AnnotationsPlacement)

SchemaExtensions.PutToClippedDocumentsForDocumentAsync(ServiceConnection, int, string, IntegerList, ContentMergeOperation?)

SchemaExtensions.PutToContentDivideForDocumentsQueryResultAsync(ServiceConnection, string, int, ContentDivideOperationInfo)

SchemaExtensions.PutToContentMergeForDocumentAsync(ServiceConnection, string, ContentMergeOperationInfo)

SchemaExtensions.PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, DocumentIndexFields)

SchemaExtensions.PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, int, string, UpdateIndexFieldsInfo)

SchemaExtensions.PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, DocumentIndexFields)

SchemaExtensions.PutToDocumentIndexFieldsForDocumentIndexFieldsAsync(ServiceConnection, CancellationToken, int, string, UpdateIndexFieldsInfo)

SchemaExtensions.PutToDocumentSectionsReorderForSectionsAsync(ServiceConnection, int, string, ReorderSectionsRequest)

SchemaExtensions.PutToDocumentSectionsReorderForSectionsAsync(ServiceConnection, CancellationToken, int, string, ReorderSectionsRequest)

SchemaExtensions.PutToProcessDocumentActionForDocumentAsync(ServiceConnection, string, int, DocumentActionInfo)

SchemaExtensions.PutToProcessDocumentActionForDocumentAsync(ServiceConnection, CancellationToken, string, int, DocumentActionInfo)

SchemaExtensions.PutToUpdateGroupForGroupAsync(ServiceConnection, Group)

SchemaExtensions.PutToUpdateGroupForGroupAsync(ServiceConnection, CancellationToken, Group)

SchemaExtensions.PutToUsersByGroupForStringAsync(ServiceConnection, string, AssignmentOperation)

ServiceConnectionExtensions.CreatePermanentUrlAsync(ServiceConnection, string)

ServiceConnectionExtensions.CreateTemplateUri(ServiceConnection, string, IEnumerable<KeyValuePair<string, object>>)

ServiceConnectionExtensions.CreateTemplateUri(ServiceConnection, string, object)

ServiceConnectionExtensions.GetFileCabinet(ServiceConnection, string)

ServiceConnectionExtensions.GetPermanentUrl(ServiceConnection, string)

Properties

HttpClient

Gets the HTTP client.

public HttpClient HttpClient { get; }

Property Value

Type	Description
HttpClient	The HTTP client.

Organizations

Gets the organizations.

public Organization[] Organizations { get; }

Property Value

Type	Description
Organization[]	The organizations.

OrganizationsAsync

Gets the organizations asynchronously.

public Task<Organization[]> OrganizationsAsync { get; }

Property Value

Type	Description
Task<Organization[]>	The organizations.

Proxy

Gets the proxy.

public HttpClientProxy Proxy { get; }

Property Value

Type	Description
HttpClientProxy	The proxy.

ServiceDescription

Gets the service description.

public ServiceDescription ServiceDescription { get; }

Property Value

Type	Description
ServiceDescription	The service description.

Methods

Create(Uri, ServiceConnectionTransportData)

Creates a connection for the specified service URI without a log in.

public static ServiceConnection Create(Uri serviceUri, ServiceConnectionTransportData serviceConnectionTransportData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
ServiceConnectionTransportData	serviceConnectionTransportData	The service connection transport data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

Create(Uri, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI without a log in.

public static ServiceConnection Create(Uri serviceUri, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
ServiceConnection	A proxy which handles further requests.

Create(Uri, string, ServiceConnectionTokenLoginData)

Creates a connection for the specified service URI.

public static ServiceConnection Create(Uri serviceUri, string token, ServiceConnectionTokenLoginData serviceConnectionTokenLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	token	The login token.
ServiceConnectionTokenLoginData	serviceConnectionTokenLoginData	The service connection token login data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

Create(Uri, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI.

public static ServiceConnection Create(Uri serviceUri, string token, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	token	The login token.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
ServiceConnection	A proxy which handles further requests.

Create(Uri, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI.

public static ServiceConnection Create(Uri serviceUri, string userName, string password, ServiceConnectionLoginData serviceConnectionData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
ServiceConnectionLoginData	serviceConnectionData	The service connection data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

Create(Uri, string, string, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI.

public static ServiceConnection Create(Uri serviceUri, string userName, string password, string organization = null, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
ServiceConnection	A proxy which handles further requests.

CreateAsync(Uri, ServiceConnectionTransportData)

Creates a connection for the specified service URI without a log in. The connection is created asynchronously.

public static Task<ServiceConnection> CreateAsync(Uri serviceUri, ServiceConnectionTransportData serviceConnectionTransportData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
ServiceConnectionTransportData	serviceConnectionTransportData	The service connection transport data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateAsync(Uri, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI without a log in. The connection is created asynchronously.

public static Task<ServiceConnection> CreateAsync(Uri serviceUri, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateAsync(Uri, string, ServiceConnectionTokenLoginData)

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateAsync(Uri serviceUri, string token, ServiceConnectionTokenLoginData serviceConnectionTokenLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	token	The login token.
ServiceConnectionTokenLoginData	serviceConnectionTokenLoginData	The service connection token login data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateAsync(Uri, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateAsync(Uri serviceUri, string token, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	token	The login token.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateAsync(Uri, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateAsync(Uri serviceUri, string userName, string password, ServiceConnectionLoginData serviceConnectionData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
ServiceConnectionLoginData	serviceConnectionData	The service connection data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateAsync(Uri, string, string, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateAsync(Uri serviceUri, string userName, string password, string organization = null, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateTrusted(Uri, string, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI.

public static ServiceConnection CreateTrusted(Uri serviceUri, string impersonatedUser, string trustedUser, string password, ServiceConnectionLoginData serviceConnectionData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	impersonatedUser	Name of the DW user.
string	trustedUser	Name of a trusted user.
string	password	The password.
ServiceConnectionLoginData	serviceConnectionData	The service connection data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

CreateTrusted(Uri, string, string, string, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI.

public static ServiceConnection CreateTrusted(Uri serviceUri, string impersonatedUser, string trustedUser, string password, string organization = null, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	impersonatedUser	Name of the impersonated(DW) user.
string	trustedUser	Name of a trusted user.
string	password	The password.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
ServiceConnection	A proxy which handles further requests.

CreateTrustedAsync(Uri, string, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateTrustedAsync(Uri serviceUri, string impersonatedUser, string trustedUser, string password, ServiceConnectionLoginData serviceConnectionData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	impersonatedUser	Name of the DW user.
string	trustedUser	Name of a trusted user.
string	password	The password.
ServiceConnectionLoginData	serviceConnectionData	The service connection data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateTrustedAsync(Uri, string, string, string, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateTrustedAsync(Uri serviceUri, string impersonatedUser, string trustedUser, string password, string organization = null, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	impersonatedUser	Name of the DW user.
string	trustedUser	Name of a trusted user.
string	password	The password.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithJwtAsync(Uri, string, ServiceConnectionTokenLoginData)

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateWithJwtAsync(Uri serviceUri, string accessToken, ServiceConnectionTokenLoginData serviceConnectionTokenLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	accessToken	The access jwt.
ServiceConnectionTokenLoginData	serviceConnectionTokenLoginData	The service connection token login data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithJwtAsync(Uri, string, ServiceConnectionTokenLoginData, Func<Task<string>>)

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateWithJwtAsync(Uri serviceUri, string accessToken, ServiceConnectionTokenLoginData serviceConnectionTokenLoginData, Func<Task<string>> refreshTokenCallback)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	accessToken	The access jwt.
ServiceConnectionTokenLoginData	serviceConnectionTokenLoginData	The service connection token login data.
Func<Task<string>>	refreshTokenCallback	Delegate for refreshing the token.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithJwtAsync(Uri, string, Func<Task<string>>, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateWithJwtAsync(Uri serviceUri, string accessToken, Func<Task<string>> refreshTokenCallback, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	accessToken	The access jwt.
Func<Task<string>>	refreshTokenCallback	Delegate for refreshing the token.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithJwtAsync(Uri, string, DWProductTypes?, HttpMessageHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI asynchronously.

public static Task<ServiceConnection> CreateWithJwtAsync(Uri serviceUri, string accessToken, DWProductTypes? licenseType = null, HttpMessageHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	accessToken	The access jwt.
DWProductTypes?	licenseType	Type of the license.
HttpMessageHandler	httpClientHandler	The HTTP message handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthentication(Uri, ICredentials, ServiceConnectionLoginData)

Creates a connection for the specified service URI using NTLM authentication.

public static ServiceConnection CreateWithWindowsAuthentication(Uri serviceUri, ICredentials credentials, ServiceConnectionLoginData serviceConnectionLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
ICredentials	credentials	The credentials. This should be some credentials which can be used in the NTLM authentication protocol.
ServiceConnectionLoginData	serviceConnectionLoginData	The service connection login data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthentication(Uri, ICredentials, string, DWProductTypes?, HttpClientHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI using windows authentication.

public static ServiceConnection CreateWithWindowsAuthentication(Uri serviceUri, ICredentials credentials, string organization = null, DWProductTypes? licenseType = null, HttpClientHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
ICredentials	credentials	The credentials.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license to lock.
HttpClientHandler	httpClientHandler	The HTTP client handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
ServiceConnection	A proxy which handles further requests.

CreateWithWindowsAuthentication(Uri, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI using NTLM authentication.

public static ServiceConnection CreateWithWindowsAuthentication(Uri serviceUri, string userName, string password, ServiceConnectionLoginData serviceConnectionLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
ServiceConnectionLoginData	serviceConnectionLoginData	The service connection login data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthentication(Uri, string, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI using NTLM authentication.

public static ServiceConnection CreateWithWindowsAuthentication(Uri serviceUri, string userName, string password, string domain, ServiceConnectionLoginData serviceConnectionLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	domain	The domain.
ServiceConnectionLoginData	serviceConnectionLoginData	The service connection login data.

Returns

Type	Description
ServiceConnection	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthentication(Uri, string, string, string, string, DWProductTypes?, HttpClientHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI using windows authentication.

public static ServiceConnection CreateWithWindowsAuthentication(Uri serviceUri, string userName, string password, string domain = null, string organization = null, DWProductTypes? licenseType = null, HttpClientHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	domain	The domain.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license to lock.
HttpClientHandler	httpClientHandler	The HTTP client handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
ServiceConnection	A proxy which handles further requests.

CreateWithWindowsAuthenticationAsync(Uri, ICredentials, ServiceConnectionLoginData)

Creates a connection for the specified service URI using NTLM authentication.

public static Task<ServiceConnection> CreateWithWindowsAuthenticationAsync(Uri serviceUri, ICredentials credentials, ServiceConnectionLoginData serviceConnectionLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
ICredentials	credentials	The credentials. This should be some credentials which can be used in the NTLM authentication protocol.
ServiceConnectionLoginData	serviceConnectionLoginData	The service connection login data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthenticationAsync(Uri, ICredentials, string, DWProductTypes?, HttpClientHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI using NTLM authentication.

public static Task<ServiceConnection> CreateWithWindowsAuthenticationAsync(Uri serviceUri, ICredentials credentials, string organization = null, DWProductTypes? licenseType = null, HttpClientHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
ICredentials	credentials	The credentials. This should be some credentials which can be used in the NTLM authentication protocol.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license to lock.
HttpClientHandler	httpClientHandler	The HTTP client handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthenticationAsync(Uri, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI using NTLM authentication.

public static Task<ServiceConnection> CreateWithWindowsAuthenticationAsync(Uri serviceUri, string userName, string password, ServiceConnectionLoginData serviceConnectionLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
ServiceConnectionLoginData	serviceConnectionLoginData	The service connection login data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthenticationAsync(Uri, string, string, string, ServiceConnectionLoginData)

Creates a connection for the specified service URI using NTLM authentication.

public static Task<ServiceConnection> CreateWithWindowsAuthenticationAsync(Uri serviceUri, string userName, string password, string domain, ServiceConnectionLoginData serviceConnectionLoginData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	domain	The domain.
ServiceConnectionLoginData	serviceConnectionLoginData	The service connection login data.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

CreateWithWindowsAuthenticationAsync(Uri, string, string, string, string, DWProductTypes?, HttpClientHandler, ProductInfoHeaderValue[])

Creates a connection for the specified service URI using NTLM authentication.

public static Task<ServiceConnection> CreateWithWindowsAuthenticationAsync(Uri serviceUri, string userName, string password, string domain = null, string organization = null, DWProductTypes? licenseType = null, HttpClientHandler httpClientHandler = null, ProductInfoHeaderValue[] userAgent = null)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
string	userName	Name of the user.
string	password	The password.
string	domain	The domain.
string	organization	The organization to connect. You do no need to specify this parameter in case there is only a single organization in the system you want to connect to.
DWProductTypes?	licenseType	Type of the license to lock.
HttpClientHandler	httpClientHandler	The HTTP client handler.
ProductInfoHeaderValue[]	userAgent	The parts of the user agent header. You should specify these values in order to identify you application. If this parameter is set to null then the process name and version of you application is used as user agent string. If you do not want to submit any user agent, you must set this parameter to an empty array.

Returns

Type	Description
Task<ServiceConnection>	A task which is creating a proxy which handles further requests.

Disconnect()

Disconnects this instance.

public void Disconnect()

DisconnectAsync()

Disconnects this instance.

public Task DisconnectAsync()

Returns

Type	Description
Task	A task which disconnects the client.

DisconnectAsync(CancellationToken)

Disconnects this instance.

public Task DisconnectAsync(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token	Cancellation token.

Returns

Type	Description
Task	A task which disconnects the client.

GetIdentityServiceInfoAsync(Uri, IdentityServiceInfoConnectionData)

Gets the identity service address.

public static Task<IdentityServiceInfo> GetIdentityServiceInfoAsync(Uri serviceUri, IdentityServiceInfoConnectionData serviceConnectionData)

Parameters

Type	Name	Description
Uri	serviceUri	The service URI.
IdentityServiceInfoConnectionData	serviceConnectionData	The service connection data.

Returns

Type	Description
Task<IdentityServiceInfo>

GetOrganizationsAsync()

Gets the organizations asynchronous.

public Task<Organization[]> GetOrganizationsAsync()

Returns

Type	Description
Task<Organization[]>	The list of available organizations.

GetXmlAsync<T>(string)

Gets the XML from the specified uri asynchronously.

public Task<DeserializedHttpResponse<T>> GetXmlAsync<T>(string uri) where T : class

Parameters

Type	Name	Description
string	uri	The URI.

Returns

Type	Description
Task<DeserializedHttpResponse<T>>	The parsed data.

Type Parameters

Name	Description
T	The type of the response.

Exceptions

Type	Condition
HttpClientRequestException	Thrown, if the request failed. In this case, you can inspect Error.

GetXml<T>(string)

Gets the XML from the specified uri.

public T GetXml<T>(string uri) where T : class

Parameters

Type	Name	Description
string	uri	The URI.

Returns

Type	Description
T	The parsed data.

Type Parameters

Name	Description
T

Exceptions

Type	Condition
HttpClientRequestException	Thrown, if the request failed. In this case, you can inspect Error.

ReplaceHttpClient(ServiceConnection)

Replaces the HTTP client.

public void ReplaceHttpClient(ServiceConnection otherServiceConnection)

Parameters

Type	Name	Description
ServiceConnection	otherServiceConnection	The ServiceConnection instance whose HttpClient instance is used for further communucation.

Remarks

After the function returns, all requests from all objects created by this ServiceConnection instance are sent through the new HttpClient instance. Then both otherServiceConnection and this ServiceConnection instance share the same HttpClient instance.

ReplaceHttpClient(HttpClient)

Replaces the HTTP client.

public void ReplaceHttpClient(HttpClient httpClient)

Parameters

Type	Name	Description
HttpClient	httpClient	The HTTP client.

SetHostId(string)

Sets the identifier of the machine the .NET API client is running.

public static void SetHostId(string hostId)

Parameters

Type	Name	Description
string	hostId	The host identifier.

Remarks

The host identifier is used by the license management to faster reuse licenses for users working on the same machine. In a .NET or Mono environment the host identifier is automatically set. If you are in a different environment, you should explicitely set the host identifier by calling this function during the initialization phase of your application.