NuxeoClient.Wrappers.BatchOperation Class Reference

Represents an Automation Operation to be performed on a batch. More...

Public Member Functions
	BatchOperation (Client client, Batch batch, string id)
	Initializes a new instance of BatchOperation. More...
Public Member Functions inherited from NuxeoClient.Operation
	Operation (Client client, string id)
	Initializes a new instance of Operation. More...
Operation	SetInput (string input)
	Sets the operation input. More...
Operation	SetInput (JToken input)
	Sets the operation input. More...
Operation	SetInput (Blob blob)
	Sets the operation input. More...
Operation	SetContext (string property, JToken value)
	Sets a context property. More...
Operation	ClearContext (string property)
	Clear a context property. More...
Operation	ClearContext ()
	Clears a context properties. More...
Operation	SetParameter (string property, JToken value)
	Sets a parameter property. More...
Operation	SetParameter (string property, ParamProperties value)
	Sets a parameter property. More...
Operation	ClearParameter (string property)
	Clears a parameter property More...
Operation	ClearParameters ()
	Clears all parameter properties. More...
Operation	AddHeader (string name, string value)
	Adds a custom header to be send in the execution request. More...
Operation	ClearHeader (string name)
	Removes a custom header, which won't be sent in the execution request. More...
Operation	SetSchemas (string[] schemas)
	Sets the document schemas to be used in the execution request. More...
Operation	SetSchemas (ICollection< string > schemas)
	Sets the document schemas to be used in the execution request. More...
Operation	AddSchema (string schema)
	Adds a document schema to be used in the execution request. More...
Operation	ClearSchema (string schema)
	Excludes a document schema from the execution request. More...
Operation	ClearSchemas ()
	Clear all document schemas from the execution request. More...
Operation	SetTimeout (int timeout)
	Sets the operation request timeout in seconds. More...
Operation	SetRepository (string repository)
	Sets the operation request repository. More...
async Task< Entity >	Execute ()
	Executes the operation, by sending a request to the server. More...

Properties
Batch	Batch [get]
	Gets the Batch over which the operation will be applied. More...
Properties inherited from NuxeoClient.Operation
Client	client [get]
	The NuxeoClient.Client through which the operation will be executed. More...
string	Id [get]
	Gets the operation id. More...
JToken	Input [get]
	Gets the operation input. More...
Dictionary< string, JToken >	Parameters [get]
	Gets the operation parameters. More...
Dictionary< string, JToken >	Context [get]
	Gets the operation request context. More...
Dictionary< string, string >	AdditionalHeaders [get]
	Gets the operation request custom headers. More...
List< string >	Schemas [get]
	Gets the operation request schemas. More...
int	Timeout [get]
	Gets the operation request timeout in seconds. More...
string	Repository = 30 [get]
	Gets the operation request repository. More...
string	Endpoint = string.Empty [get, protected set]
	Gets the operation endpoint. More...
bool	IsMultipart [get]
	Gets whether or not the operation request is multipart or not. More...

Detailed Description

Represents an Automation Operation to be performed on a batch.

Definition at line 23 of file BatchOperation.cs.

Inheritance diagram for NuxeoClient.Wrappers.BatchOperation:

Constructor & Destructor Documentation

NuxeoClient.Wrappers.BatchOperation.BatchOperation	(	Client	client,
		Batch	batch,
		string	id
	)

Initializes a new instance of BatchOperation.

Parameters

client	The client over which the operation is to be executed.
batch	The Batch over which the operation is to be executed.
id	The operation id.

Definition at line 36 of file BatchOperation.cs.

Property Documentation

Batch NuxeoClient.Wrappers.BatchOperation.Batch

get

Gets the Batch over which the operation will be applied.

Definition at line 28 of file BatchOperation.cs.