NuxeoDotNetClient  1.0.0 beta
.NET Client for Nuxeo Automation and REST API
Public Member Functions | Properties | List of all members
NuxeoClient.Adapters.ConvertAdapter Class Reference

Represents a Convert Adapter, which converts target document blobs int other formats. More...

Public Member Functions

 ConvertAdapter ()
 Initializes a new instance of ConvertAdapter. More...
 
ConvertAdapter SetFormat (string format)
 Sets the target conversion format. More...
 
- Public Member Functions inherited from NuxeoClient.Adapters.Adapter
 Adapter (string id)
 Initializes a new instance of Adapter. More...
 
string GetEndpointSuffix ()
 Returns the endpoint suffix to the current Adapter, to be appended to other requests. More...
 

Properties

string Format [get, protected set]
 Gets the target conversion format. More...
 
QueryParams QParams = string.Empty [get, set]
 Gets the parameters of the ConvertAdapter. More...
 
- Properties inherited from NuxeoClient.Adapters.Adapter
String Id [get, protected set]
 Gets the Adapter's ID. More...
 
String Parameters [get, set]
 Gets the adapter parameters to be sent on the request. More...
 

Detailed Description

Represents a Convert Adapter, which converts target document blobs int other formats.

For more details about Adapters, check Nuxeo Documentation Page.

Definition at line 25 of file ConvertAdapter.cs.

Inheritance diagram for NuxeoClient.Adapters.ConvertAdapter:
NuxeoClient.Adapters.Adapter

Constructor & Destructor Documentation

NuxeoClient.Adapters.ConvertAdapter.ConvertAdapter ( )

Initializes a new instance of ConvertAdapter.

Definition at line 40 of file ConvertAdapter.cs.

Member Function Documentation

ConvertAdapter NuxeoClient.Adapters.ConvertAdapter.SetFormat ( string  format)

Sets the target conversion format.

Parameters
formatThe target conversion format.
Returns
The current ConvertAdapter instance.

Definition at line 49 of file ConvertAdapter.cs.

Property Documentation

string NuxeoClient.Adapters.ConvertAdapter.Format
getprotected set

Gets the target conversion format.

Definition at line 30 of file ConvertAdapter.cs.

QueryParams NuxeoClient.Adapters.ConvertAdapter.QParams = string.Empty
getsetprotected

Gets the parameters of the ConvertAdapter.

Definition at line 35 of file ConvertAdapter.cs.