ServiceConnection ClassDocuWare Platform .NET API
Encapsulates a connection to the platform.
Inheritance Hierarchy

SystemObject
  DocuWare.Platform.ServerClientServiceConnection

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

C#
public class ServiceConnection

The ServiceConnection type exposes the following members.

Methods

  NameDescription
Public methodConnectAsync(String, NullableDWProductTypes, ProductInfoHeaderValue)
Connects this instance with new credentials.
Public methodConnectAsync(String, String, String, NullableDWProductTypes, ProductInfoHeaderValue)
Connects this instance with new credentials.
Public methodStatic memberCreate(Uri, HttpMessageHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI without a log in.
Public methodStatic memberCreate(Uri, String, NullableDWProductTypes, HttpMessageHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI.
Public methodStatic memberCreate(Uri, String, String, String, NullableDWProductTypes, HttpMessageHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI.
Public methodStatic memberCreateAsync(Uri, HttpMessageHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI without a log in. The connection is created asynchronously.
Public methodStatic memberCreateAsync(Uri, String, NullableDWProductTypes, HttpMessageHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI asynchronously.
Public methodStatic memberCreateAsync(Uri, String, String, String, NullableDWProductTypes, HttpMessageHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI asynchronously.
Public methodStatic memberCreateWithWindowsAuthentication(Uri, ICredentials, String, NullableDWProductTypes, HttpClientHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI using windows authentication.
Public methodStatic memberCreateWithWindowsAuthentication(Uri, String, String, String, String, NullableDWProductTypes, HttpClientHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI using windows authentication.
Public methodStatic memberCreateWithWindowsAuthenticationAsync(Uri, ICredentials, String, NullableDWProductTypes, HttpClientHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI using NTLM authentication.
Public methodStatic memberCreateWithWindowsAuthenticationAsync(Uri, String, String, String, String, NullableDWProductTypes, HttpClientHandler, ProductInfoHeaderValue)
Creates a connection for the specified service URI using NTLM authentication.
Public methodDisconnect
Disconnects this instance.
Public methodDisconnectAsync
Disconnects this instance.
Public methodGetXmlT
Gets the XML from the specified uri.
Public methodGetXmlAsyncT
Gets the XML from the specified uri asynchronously.
Top
Extension Methods

  NameDescription
Public Extension MethodCreatePermanentUrlAsync
Creates the permanent URL asynchronous.
(Defined by ServiceConnectionExtensions.)
Public Extension MethodCreateTemplateUri(String, Object)Overloaded.
Creates the template URI.
(Defined by ServiceConnectionExtensions.)
Public Extension MethodCreateTemplateUri(String, IEnumerableKeyValuePairString, Object)Overloaded.
Creates the template URI.
(Defined by ServiceConnectionExtensions.)
Public Extension MethodDeleteFromDocumentDeleteForStringAsync (Defined by SchemaExtensions.)
Public Extension MethodEasyCheckInFromFileSystemAsync(FileInfo)Overloaded.
Checks the specified file in.
(Defined by StreamResponseExtensions.)
Public Extension MethodEasyCheckInFromFileSystemAsync(FileInfo, CheckInActionParameters)Overloaded.
Checks the specified file in.
(Defined by StreamResponseExtensions.)
Public Extension MethodEasyCheckOutToFileSystemAsync
Checks out the specified file and saves it to the file system asynchronously.
(Defined by StreamResponseExtensions.)
Public Extension MethodGetFileCabinet
Gets a FileCabinet instance directly.
(Defined by ServiceConnectionExtensions.)
Public Extension MethodGetFromAnnotationForAnnotationAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromDialogForDialogAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromDocumentDocumentLinksForDocumentLinksAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromDocumentForDocumentAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromDocumentIndexFieldsForDocumentIndexFieldsAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromDocumentsFileDownloadForStreamAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromDocumentsForDocumentsQueryResultAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromFileCabinetForFileCabinetAsync (Defined by SchemaExtensions.)
Public Extension MethodGetFromPagesBlockForPagesAsync (Defined by SchemaExtensions.)
Public Extension MethodGetPermanentUrl
Creates the permanent URL asynchronous.
(Defined by ServiceConnectionExtensions.)
Public Extension MethodPostToAnnotationForAnnotationAsync(String, String, Int32, Annotation)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPostToAnnotationForAnnotationAsync(String, String, Int32, AnnotationsPlacement)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPostToBatchDialogUpdateFieldsForBatchUpdateIndexFieldsResultAsync (Defined by SchemaExtensions.)
Public Extension MethodPostToCheckinForDocumentAsync (Defined by SchemaExtensions.)
Public Extension MethodPostToCheckoutForStreamAsync (Defined by SchemaExtensions.)
Public Extension MethodPostToCreatePermanentUrlForStringAsync (Defined by SchemaExtensions.)
Public Extension MethodPostToDocumentAppendFilesForDocumentAsync (Defined by SchemaExtensions.)
Public Extension MethodPostToDocumentIndexFieldsForDocumentIndexFieldsAsync(Int32, String, DocumentIndexFields)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPostToDocumentIndexFieldsForDocumentIndexFieldsAsync(Int32, String, UpdateIndexFieldsInfo)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPostToDocumentRightsForRightsAsync (Defined by SchemaExtensions.)
Public Extension MethodPostToUploadDocumentForDocumentAsync(String, Document, NullableBoolean, NullableBoolean, String, String)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPostToUploadDocumentForDocumentAsync(String, Stream, NullableBoolean, NullableBoolean, String, String)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPostToValidateUserForStringAsync (Defined by SchemaExtensions.)
Public Extension MethodPutToAnnotationForAnnotationAsync(String, String, Int32, Annotation)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPutToAnnotationForAnnotationAsync(String, String, Int32, AnnotationsPlacement)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPutToDocumentIndexFieldsForDocumentIndexFieldsAsync(Int32, String, DocumentIndexFields)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPutToDocumentIndexFieldsForDocumentIndexFieldsAsync(Int32, String, UpdateIndexFieldsInfo)Overloaded. (Defined by SchemaExtensions.)
Public Extension MethodPutToProcessDocumentActionForDocumentAsync (Defined by SchemaExtensions.)
Top
Properties

  NameDescription
Public propertyHttpClient
Gets the HTTP client.
Public propertyOrganizations
Gets the organizations.
Public propertyServiceDescription
Gets the service description.
Top
See Also

Reference