NuxeoClient.Operation Class Reference

Represents a Nuxeo Automation Operation. More...

Public Member Functions
	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
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 a Nuxeo Automation Operation.

For more details about Automation Operations, check Nuxeo Documentation Center.

Definition at line 31 of file Operation.cs.

Inheritance diagram for NuxeoClient.Operation:

Constructor & Destructor Documentation

NuxeoClient.Operation.Operation	(	Client	client,
		string	id
	)

Initializes a new instance of Operation.

Parameters

client	The client through which the operation will be executed.
id	The operation id.

Definition at line 93 of file Operation.cs.

Member Function Documentation

Operation NuxeoClient.Operation.AddHeader	(	string	name,
		string	value
	)

Adds a custom header to be send in the execution request.

Parameters

name	The header's name.
value	The header's value.

Returns

The current Operation instance.

Definition at line 226 of file Operation.cs.

Operation NuxeoClient.Operation.AddSchema

(

string

schema

)

Adds a document schema to be used in the execution request.

For more details about schemas, check Nuxeo Documentation Center.

Parameters

schema

The schema name.

Returns

The current Operation instance.

Definition at line 290 of file Operation.cs.

Operation NuxeoClient.Operation.ClearContext

(

string

property

)

Clear a context property.

Parameters

property

The property's name.

Returns

The current Operation instance.

Definition at line 157 of file Operation.cs.

Operation NuxeoClient.Operation.ClearContext

(

)

Clears a context properties.

Returns

The current Operation instance.

Definition at line 167 of file Operation.cs.

Operation NuxeoClient.Operation.ClearHeader

(

string

name

)

Removes a custom header, which won't be sent in the execution request.

Parameters

name	The header's name.

Returns

The current Operation instance.

Definition at line 238 of file Operation.cs.

Operation NuxeoClient.Operation.ClearParameter

(

string

property

)

Clears a parameter property

Parameters

property

The property's name.

Returns

The current Operation instance.

Definition at line 204 of file Operation.cs.

Operation NuxeoClient.Operation.ClearParameters

(

)

Clears all parameter properties.

Returns

The current Operation instance.

Definition at line 214 of file Operation.cs.

Operation NuxeoClient.Operation.ClearSchema

(

string

schema

)

Excludes a document schema from the execution request.

For more details about schemas, check Nuxeo Documentation Center.

Parameters

schema

The schema name.

Returns

The current Operation instance.

Definition at line 305 of file Operation.cs.

Operation NuxeoClient.Operation.ClearSchemas

(

)

Clear all document schemas from the execution request.

Returns

The current Operation instance.

Definition at line 315 of file Operation.cs.

async Task<Entity> NuxeoClient.Operation.Execute

(

)

Executes the operation, by sending a request to the server.

Returns

A Task that will return an instance of Entity with the operation result.

Definition at line 347 of file Operation.cs.

Operation NuxeoClient.Operation.SetContext	(	string	property,
		JToken	value
	)

Sets a context property.

Parameters

property	The property's name.
value	The property's value.

Returns

The current Operation instance.

Definition at line 145 of file Operation.cs.

Operation NuxeoClient.Operation.SetInput

(

string

input

)

Sets the operation input.

Parameters

input

The operation input.

Returns

The current Operation instance.

Definition at line 108 of file Operation.cs.

Operation NuxeoClient.Operation.SetInput

(

JToken

input

)

Sets the operation input.

Parameters

input

The operation input.

Returns

The current Operation instance.

Definition at line 120 of file Operation.cs.

Operation NuxeoClient.Operation.SetInput

(

Blob

blob

)

Sets the operation input.

Parameters

input

The operation input.

Returns

The current Operation instance.

Definition at line 132 of file Operation.cs.

Operation NuxeoClient.Operation.SetParameter	(	string	property,
		JToken	value
	)

Sets a parameter property.

Parameters

property	The property's name.
value	The property's value.

Returns

The current Operation instance.

Definition at line 179 of file Operation.cs.

Operation NuxeoClient.Operation.SetParameter	(	string	property,
		ParamProperties	value
	)

Sets a parameter property.

Parameters

property	The property's name.
value	The property's value.

Returns

The current Operation instance.

Definition at line 192 of file Operation.cs.

Operation NuxeoClient.Operation.SetRepository

(

string

repository

)

Sets the operation request repository.

Parameters

repository

The repository path.

Returns

The current Operation instance.

Definition at line 337 of file Operation.cs.

Operation NuxeoClient.Operation.SetSchemas

(

string[]

schemas

)

Sets the document schemas to be used in the execution request.

For more details about schemas, check Nuxeo Documentation Center.

Parameters

schemas

An array containing the schema names.

Returns

The current Operation instance.

Definition at line 252 of file Operation.cs.

Operation NuxeoClient.Operation.SetSchemas

(

ICollection< string >

schemas

)

Sets the document schemas to be used in the execution request.

For more details about schemas, check Nuxeo Documentation Center.

Parameters

schemas

A ICollection<string> containing the schema names.

Returns

The current Operation instance.

Definition at line 271 of file Operation.cs.

Operation NuxeoClient.Operation.SetTimeout

(

int

timeout

)

Sets the operation request timeout in seconds.

Parameters

timeout

The timeout in seconds.

Returns

The current Operation instance.

Definition at line 326 of file Operation.cs.

Property Documentation

Dictionary<string, string> NuxeoClient.Operation.AdditionalHeaders

get

Gets the operation request custom headers.

Definition at line 61 of file Operation.cs.

Client NuxeoClient.Operation.client

getprotected

The NuxeoClient.Client through which the operation will be executed.

Definition at line 36 of file Operation.cs.

Dictionary<string, JToken> NuxeoClient.Operation.Context

get

Gets the operation request context.

Definition at line 56 of file Operation.cs.

string NuxeoClient.Operation.Endpoint = string.Empty

getprotected set

Gets the operation endpoint.

Definition at line 81 of file Operation.cs.

string NuxeoClient.Operation.Id

get

Gets the operation id.

Definition at line 41 of file Operation.cs.

JToken NuxeoClient.Operation.Input

get

Gets the operation input.

Definition at line 46 of file Operation.cs.

bool NuxeoClient.Operation.IsMultipart

get

Gets whether or not the operation request is multipart or not.

Definition at line 86 of file Operation.cs.

Dictionary<string, JToken> NuxeoClient.Operation.Parameters

get

Gets the operation parameters.

Definition at line 51 of file Operation.cs.

string NuxeoClient.Operation.Repository = 30

get

Gets the operation request repository.

Definition at line 76 of file Operation.cs.

List<string> NuxeoClient.Operation.Schemas

get

Gets the operation request schemas.

Definition at line 66 of file Operation.cs.

int NuxeoClient.Operation.Timeout

get

Gets the operation request timeout in seconds.

Definition at line 71 of file Operation.cs.