C# Класс DocRaptor.Api.DocApi

Represents a collection of functions to interact with the API endpoints

Наследование: IDocApi

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
CreateAsyncDoc ( Doc doc ) : AsyncDoc	Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
CreateAsyncDocAsync ( Doc doc ) : System.Threading.Tasks.Task	Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
CreateAsyncDocAsyncWithHttpInfo ( Doc doc ) : System.Threading.Tasks.Task>	Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
CreateAsyncDocWithHttpInfo ( Doc doc ) : ApiResponse	Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
CreateDoc ( Doc doc ) : byte[]	Creates a document synchronously.
CreateDocAsync ( Doc doc ) : System.Threading.Tasks.Task	Creates a document synchronously.
CreateDocAsyncWithHttpInfo ( Doc doc ) : System.Threading.Tasks.Task>	Creates a document synchronously.
CreateDocWithHttpInfo ( Doc doc ) : ApiResponse	Creates a document synchronously.
DocApi ( Configuration configuration = null ) : System	Initializes a new instance of the DocApi class using Configuration object
DocApi ( String basePath ) : System	Initializes a new instance of the DocApi class.
GetAsyncDoc ( string id ) : byte[]	Downloads a document.
GetAsyncDocAsync ( string id ) : System.Threading.Tasks.Task	Downloads a document.
GetAsyncDocAsyncWithHttpInfo ( string id ) : System.Threading.Tasks.Task>	Downloads a document.
GetAsyncDocStatus ( string id ) : AsyncDocStatus	Check on the status of an asynchronously created document.
GetAsyncDocStatusAsync ( string id ) : System.Threading.Tasks.Task	Check on the status of an asynchronously created document.
GetAsyncDocStatusAsyncWithHttpInfo ( string id ) : System.Threading.Tasks.Task>	Check on the status of an asynchronously created document.
GetAsyncDocStatusWithHttpInfo ( string id ) : ApiResponse	Check on the status of an asynchronously created document.
GetAsyncDocWithHttpInfo ( string id ) : ApiResponse	Downloads a document.
GetBasePath ( ) : String	Gets the base path of the API client.

Приватные методы

Метод	Описание
AddDefaultHeader ( string key, string value ) : void
DefaultHeader ( ) : String>.Dictionary
SetBasePath ( String basePath ) : void

Описание методов

CreateAsyncDoc() публичный Метод

Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.

Thrown when fails to make API call

public CreateAsyncDoc ( Doc doc ) : AsyncDoc
doc	Doc	The document to be created.
Результат	AsyncDoc

CreateAsyncDocAsync() публичный Метод

Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.

Thrown when fails to make API call

public CreateAsyncDocAsync ( Doc doc ) : System.Threading.Tasks.Task
doc	Doc	The document to be created.
Результат	System.Threading.Tasks.Task

CreateAsyncDocAsyncWithHttpInfo() публичный Метод

Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.

Thrown when fails to make API call

public CreateAsyncDocAsyncWithHttpInfo ( Doc doc ) : System.Threading.Tasks.Task>
doc	Doc	The document to be created.
Результат	System.Threading.Tasks.Task>

CreateAsyncDocWithHttpInfo() публичный Метод

Creates a document asynchronously. You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.

Thrown when fails to make API call

public CreateAsyncDocWithHttpInfo ( Doc doc ) : ApiResponse
doc	Doc	The document to be created.
Результат	ApiResponse

CreateDoc() публичный Метод

Creates a document synchronously.

Thrown when fails to make API call

public CreateDoc ( Doc doc ) : byte[]
doc	Doc	The document to be created.
Результат	byte[]

CreateDocAsync() публичный Метод

Creates a document synchronously.

Thrown when fails to make API call

public CreateDocAsync ( Doc doc ) : System.Threading.Tasks.Task
doc	Doc	The document to be created.
Результат	System.Threading.Tasks.Task

CreateDocAsyncWithHttpInfo() публичный Метод

Creates a document synchronously.

Thrown when fails to make API call

public CreateDocAsyncWithHttpInfo ( Doc doc ) : System.Threading.Tasks.Task>
doc	Doc	The document to be created.
Результат	System.Threading.Tasks.Task>

CreateDocWithHttpInfo() публичный Метод

Creates a document synchronously.

Thrown when fails to make API call

public CreateDocWithHttpInfo ( Doc doc ) : ApiResponse
doc	Doc	The document to be created.
Результат	ApiResponse

DocApi() публичный Метод

Initializes a new instance of the DocApi class using Configuration object

public DocApi ( Configuration configuration = null ) : System
configuration	DocRaptor.Client.Configuration	An instance of Configuration
Результат	System

DocApi() публичный Метод

Initializes a new instance of the DocApi class.

public DocApi ( String basePath ) : System
basePath	String
Результат	System

GetAsyncDoc() публичный Метод

Downloads a document.

Thrown when fails to make API call

public GetAsyncDoc ( string id ) : byte[]
id	string	The download_id returned from status request or a callback.
Результат	byte[]

GetAsyncDocAsync() публичный Метод

Downloads a document.

Thrown when fails to make API call

public GetAsyncDocAsync ( string id ) : System.Threading.Tasks.Task
id	string	The download_id returned from status request or a callback.
Результат	System.Threading.Tasks.Task

GetAsyncDocAsyncWithHttpInfo() публичный Метод

Downloads a document.

Thrown when fails to make API call

public GetAsyncDocAsyncWithHttpInfo ( string id ) : System.Threading.Tasks.Task>
id	string	The download_id returned from status request or a callback.
Результат	System.Threading.Tasks.Task>

GetAsyncDocStatus() публичный Метод

Check on the status of an asynchronously created document.

Thrown when fails to make API call

public GetAsyncDocStatus ( string id ) : AsyncDocStatus
id	string	The status_id returned when creating an asynchronous document.
Результат	AsyncDocStatus

GetAsyncDocStatusAsync() публичный Метод

Check on the status of an asynchronously created document.

Thrown when fails to make API call

public GetAsyncDocStatusAsync ( string id ) : System.Threading.Tasks.Task
id	string	The status_id returned when creating an asynchronous document.
Результат	System.Threading.Tasks.Task

GetAsyncDocStatusAsyncWithHttpInfo() публичный Метод

Check on the status of an asynchronously created document.

Thrown when fails to make API call

public GetAsyncDocStatusAsyncWithHttpInfo ( string id ) : System.Threading.Tasks.Task>
id	string	The status_id returned when creating an asynchronous document.
Результат	System.Threading.Tasks.Task>

GetAsyncDocStatusWithHttpInfo() публичный Метод

Check on the status of an asynchronously created document.

Thrown when fails to make API call

public GetAsyncDocStatusWithHttpInfo ( string id ) : ApiResponse
id	string	The status_id returned when creating an asynchronous document.
Результат	ApiResponse

GetAsyncDocWithHttpInfo() публичный Метод

Downloads a document.

Thrown when fails to make API call

public GetAsyncDocWithHttpInfo ( string id ) : ApiResponse
id	string	The download_id returned from status request or a callback.
Результат	ApiResponse

GetBasePath() публичный Метод

Gets the base path of the API client.

public GetBasePath ( ) : String
Результат	String