C# Class DocRaptor.Api.DocApi

Represents a collection of functions to interact with the API endpoints

Inheritance: IDocApi

Datei anzeigen Open project: DocRaptor/docraptor-csharp Class Usage Examples

Public Methods

Method	Description
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.

Private Methods

Method	Description
AddDefaultHeader ( string key, string value ) : void
DefaultHeader ( ) : String>.Dictionary
SetBasePath ( String basePath ) : void

Method Details

CreateAsyncDoc() public method

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.
return	AsyncDoc

CreateAsyncDocAsync() public method

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.
return	System.Threading.Tasks.Task

CreateAsyncDocAsyncWithHttpInfo() public method

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.
return	System.Threading.Tasks.Task>

CreateAsyncDocWithHttpInfo() public method

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.
return	ApiResponse

CreateDoc() public method

Creates a document synchronously.

Thrown when fails to make API call

public CreateDoc ( Doc doc ) : byte[]
doc	Doc	The document to be created.
return	byte[]

CreateDocAsync() public method

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.
return	System.Threading.Tasks.Task

CreateDocAsyncWithHttpInfo() public method

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.
return	System.Threading.Tasks.Task>

CreateDocWithHttpInfo() public method

Creates a document synchronously.

Thrown when fails to make API call

public CreateDocWithHttpInfo ( Doc doc ) : ApiResponse
doc	Doc	The document to be created.
return	ApiResponse

DocApi() public method

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
return	System

DocApi() public method

Initializes a new instance of the DocApi class.

public DocApi ( String basePath ) : System
basePath	String
return	System

GetAsyncDoc() public method

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.
return	byte[]

GetAsyncDocAsync() public method

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.
return	System.Threading.Tasks.Task

GetAsyncDocAsyncWithHttpInfo() public method

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.
return	System.Threading.Tasks.Task>

GetAsyncDocStatus() public method

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.
return	AsyncDocStatus

GetAsyncDocStatusAsync() public method

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.
return	System.Threading.Tasks.Task

GetAsyncDocStatusAsyncWithHttpInfo() public method

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.
return	System.Threading.Tasks.Task>

GetAsyncDocStatusWithHttpInfo() public method

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.
return	ApiResponse

GetAsyncDocWithHttpInfo() public method

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.
return	ApiResponse

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String