C# Class NuxeoClient.Operation

Represents a Nuxeo Automation Operation.

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

Show file Open project: nuxeo/nuxeo-dotnet-client

Public Methods

Method	Description
AddHeader ( string name, string value ) : Operation	Adds a custom header to be send in the execution request.
AddSchema ( string schema ) : Operation	Adds a document schema to be used in the execution request. For more details about schemas, check Nuxeo Documentation Center.
ClearContext ( ) : Operation	Clears a context properties.
ClearContext ( string property ) : Operation	Clear a context property.
ClearHeader ( string name ) : Operation	Removes a custom header, which won't be sent in the execution request.
ClearParameter ( string property ) : Operation	Clears a parameter property
ClearParameters ( ) : Operation	Clears all parameter properties.
ClearSchema ( string schema ) : Operation	Excludes a document schema from the execution request. For more details about schemas, check Nuxeo Documentation Center.
ClearSchemas ( ) : Operation	Clear all document schemas from the execution request.
Execute ( ) : Task	Executes the operation, by sending a request to the server.
Operation ( Client client, string id ) : Newtonsoft.Json.Linq	Initializes a new instance of Operation.
SetContext ( string property, JToken value ) : Operation	Sets a context property.
SetInput ( Blob input ) : Operation	Sets the operation input.
SetInput ( BlobList input ) : Operation	Sets the operation input.
SetInput ( JToken input ) : Operation	Sets the operation input.
SetInput ( string input ) : Operation	Sets the operation input.
SetParameter ( string property, JToken value ) : Operation	Sets a parameter property.
SetParameter ( string property, ParamProperties value ) : Operation	Sets a parameter property.
SetRepository ( string repository ) : Operation	Sets the operation request repository.
SetSchemas ( ICollection schemas ) : Operation	Sets the document schemas to be used in the execution request. For more details about schemas, check Nuxeo Documentation Center.
SetSchemas ( string schemas ) : Operation	Sets the document schemas to be used in the execution request. For more details about schemas, check Nuxeo Documentation Center.
SetTimeout ( int timeout ) : Operation	Sets the operation request timeout in seconds.

Method Details

AddHeader() public method

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

public AddHeader ( string name, string value ) : Operation
name	string	The header's name.
value	string	The header's value.
return	Operation

AddSchema() public method

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

For more details about schemas, check Nuxeo Documentation Center.

public AddSchema ( string schema ) : Operation
schema	string	The schema name.
return	Operation

ClearContext() public method

Clears a context properties.

public ClearContext ( ) : Operation
return	Operation

ClearContext() public method

Clear a context property.

public ClearContext ( string property ) : Operation
property	string	The property's name.
return	Operation

ClearHeader() public method

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

public ClearHeader ( string name ) : Operation
name	string	The header's name.
return	Operation

ClearParameter() public method

Clears a parameter property

public ClearParameter ( string property ) : Operation
property	string	The property's name.
return	Operation

ClearParameters() public method

Clears all parameter properties.

public ClearParameters ( ) : Operation
return	Operation

ClearSchema() public method

Excludes a document schema from the execution request.

For more details about schemas, check Nuxeo Documentation Center.

public ClearSchema ( string schema ) : Operation
schema	string	The schema name.
return	Operation

ClearSchemas() public method

Clear all document schemas from the execution request.

public ClearSchemas ( ) : Operation
return	Operation

Execute() public method

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

public Execute ( ) : Task
return	Task

Operation() public method

Initializes a new instance of Operation.

public Operation ( Client client, string id ) : Newtonsoft.Json.Linq
client	Client	The client through which the operation will be executed.
id	string	The operation id.
return	Newtonsoft.Json.Linq

SetContext() public method

Sets a context property.

public SetContext ( string property, JToken value ) : Operation
property	string	The property's name.
value	JToken	The property's value.
return	Operation

SetInput() public method

Sets the operation input.

public SetInput ( Blob input ) : Operation
input	Blob	The operation input.
return	Operation

SetInput() public method

Sets the operation input.

public SetInput ( BlobList input ) : Operation
input	BlobList	The operation input.
return	Operation

SetInput() public method

Sets the operation input.

public SetInput ( JToken input ) : Operation
input	JToken	The operation input.
return	Operation

SetInput() public method

Sets the operation input.

public SetInput ( string input ) : Operation
input	string	The operation input.
return	Operation

SetParameter() public method

Sets a parameter property.

public SetParameter ( string property, JToken value ) : Operation
property	string	The property's name.
value	JToken	The property's value.
return	Operation

SetParameter() public method

Sets a parameter property.

public SetParameter ( string property, ParamProperties value ) : Operation
property	string	The property's name.
value	ParamProperties	The property's value.
return	Operation

SetRepository() public method

Sets the operation request repository.

public SetRepository ( string repository ) : Operation
repository	string	The repository path.
return	Operation

SetSchemas() public method

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

For more details about schemas, check Nuxeo Documentation Center.

public SetSchemas ( ICollection schemas ) : Operation
schemas	ICollection	A collection of strings containing the schema names.
return	Operation

SetSchemas() public method

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

For more details about schemas, check Nuxeo Documentation Center.

public SetSchemas ( string schemas ) : Operation
schemas	string	An array containing the schema names.
return	Operation

SetTimeout() public method

Sets the operation request timeout in seconds.

public SetTimeout ( int timeout ) : Operation
timeout	int	The timeout in seconds.
return	Operation