C# 클래스 DocRaptor.Api.DocApi

Represents a collection of functions to interact with the API endpoints

상속: IDocApi

파일 보기 프로젝트 열기: DocRaptor/docraptor-csharp 1 사용 예제들

공개 메소드들

메소드	설명
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