DocuwareClient Class

Definition

Namespace:

Azure.Connectors.Sdk.Docuware

Assembly:

Azure.Connectors.Sdk.dll

Package:

Azure.Connectors.Sdk v0.13.0-preview.1

Typed client for docuware connector.

public class DocuwareClient : Azure.Connectors.Sdk.ConnectorClientBase

type DocuwareClient = class
    inherit ConnectorClientBase

Public Class DocuwareClient
Inherits ConnectorClientBase

Inheritance

Object

ConnectorClientBase

DocuwareClient

Constructors

Name	Description
DocuwareClient()
DocuwareClient(String)	Creates a new DocuwareClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.
DocuwareClient(Uri, TokenCredential, ConnectorClientOptions)	Creates a new DocuwareClient with the specified connection runtime URL and credential.
DocuwareClient(Uri, TokenCredential)	Creates a new DocuwareClient with the specified connection runtime URL and credential.
DocuwareClient(Uri)	Creates a new DocuwareClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name	Description
ConnectorName
Pipeline	Gets the HTTP pipeline for making connector requests. (Inherited from ConnectorClientBase)

Methods

Name	Description
AppendFileAsync(String, String, CancellationToken)	Append a file
CallConnectorAsync(HttpMethod, String, Object, CancellationToken)	Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)	Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
DeleteDocumentAsync(String, Int32, CancellationToken)	Delete a document
DeleteFileAsync(String, Int32, Int32, CancellationToken)	Delete a file
Dispose()	(Inherited from ConnectorClientBase)
Dispose(Boolean)	Disposes the connector client resources. (Inherited from ConnectorClientBase)
DownloadDocumentAsync(String, Int32, String, CancellationToken)	Download a document
DownloadFileAsync(String, Int32, String, String, CancellationToken)	Download a file
GetDialogFieldsAsync(String, String, CancellationToken)	Get dialog fields
GetDialogsAsync(String, String, CancellationToken)	Get dialogs
GetDocumentInformationAsync(String, Int32, CancellationToken)	Get document information
GetFileCabinetFieldsAsync(String, String, CancellationToken)	Get file cabinet fields
GetFileCabinetsAsync(String, CancellationToken)	Get file cabinets and document trays
GetOrganizationAsync(CancellationToken)	Get organization
GetStampFieldsAsync(String, String, CancellationToken)	Get stamp fields
GetStampsAsync(String, CancellationToken)	Get stamps
ImportToDocumentTrayAsync(String, String, CancellationToken)	Import to document tray
ListDocumentsInDocumentTrayAsync(String, CancellationToken)	List documents in document tray
PlaceAStampAsync(String, Int32, PlaceAStampInput, CancellationToken)	Place a stamp
ReplaceFileAsync(String, Int32, Int32, CancellationToken)	Replace a file
ResolveUrl(String)	Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth. (Inherited from ConnectorClientBase)
SearchForDocumentsInFileCabinetAsync(String, SearchForDocumentsInFileCabinetInput, String, CancellationToken)	Search in file cabinet
StoreToFileCabinetAsync(String, String, CancellationToken)	Store to file cabinet
TransferDocumentAsync(String, TransferDocumentInput, String, CancellationToken)	Transfer documents
UpdateIndexFieldsAsync(String, Int32, List<Nullable<JsonElement>>, CancellationToken)	Update index fields