Represents a remote batch in the Nuxeo server, to which one ore more files can be uploaded. More...

Public Member Functions
	Batch ()
	Initializes a new instance of Batch. More...

Batch	SetClient (Client client)
	Sets the Nuxeo Client instance through which the requests for this batch will be made. More...

Operation	Operation (string operationId)
	Creates a new instance of Operation to be executed on all uploaded files in the current batch. More...

async Task< Batch >	Upload (UploadJob job)
	Executes a non-chnked UploadJob. More...

async Task< Batch >	UploadChunk (UploadJob job)
	Executes a chunked UploadJob. More...

async Task< BatchInfo >	Drop ()
	Drops the current Batch from the server. More...

async Task< EntityList >	Info ()
	Requests information regarding all the files uploaded so far. More...

async Task< BatchFile >	Info (int fileIndex)
	Requests information about a particular uploaded file. More...

Public Member Functions inherited from NuxeoClient.Wrappers.BatchInfo
	BatchInfo ()
	Initializes a new instance of BatchInfo. More...

Public Member Functions inherited from NuxeoClient.Wrappers.Entity
	Entity ()
	Initializes a new instance of Entity. More...

Properties
string	Endpoint `[get]`
	Gets the endpoint of the batch. More...

Client	client `[get]`

Properties inherited from NuxeoClient.Wrappers.BatchInfo
string	BatchId `[get, set]`
	Gets the bach ID. More...

int	FileIndex = string.Empty `[get, set]`
	Gets the file index. More...

string	UploadType = 0 `[get, set]`
	Gets the type of upload. More...

int	UploadSize = string.Empty `[get, set]`
	Gets the size of the upload. More...

bool	Dropped = 0 `[get, set]`
	Gets whether the batch was dropped or not. More...

int	UploadedChunkId = false `[get, set]`
	Gets the id of the chunk. More...

int	ChunkCount = 0 `[get, set]`
	Gets the total amount of chunks. More...

Properties inherited from NuxeoClient.Wrappers.Entity
string	EntityType `[get, set]`
	Gets the entity type. More...

Detailed Description

Represents a remote batch in the Nuxeo server, to which one ore more files can be uploaded.

For more details about file uploading, check How to Upload a File @ Nuxeo Documentation Center. For more information about batch upload, check Blob Upload for Batch Processing @ Nuxeo Documentation Center.

Definition at line 34 of file Batch.cs.

Inheritance diagram for NuxeoClient.Wrappers.Batch:

Constructor & Destructor Documentation

NuxeoClient.Wrappers.Batch.Batch ( )

Initializes a new instance of Batch.

Definition at line 47 of file Batch.cs.

Member Function Documentation

async Task<BatchInfo> NuxeoClient.Wrappers.Batch.Drop ( )

Drops the current Batch from the server.

Returns: A BatchInfo instance contaning information regarding the drop operation.

Definition at line 112 of file Batch.cs.

async Task<EntityList> NuxeoClient.Wrappers.Batch.Info ( )

Requests information regarding all the files uploaded so far.

Returns: A EntityList containing an instance of BatchFile per uploaded file.

Definition at line 121 of file Batch.cs.

async Task<BatchFile> NuxeoClient.Wrappers.Batch.Info ( int fileIndex )

Requests information about a particular uploaded file.

Parameters

fileIndex The index of the uploaded file.

Returns: An instance of BatchFile containing information about the file.

Definition at line 131 of file Batch.cs.

Operation NuxeoClient.Wrappers.Batch.Operation ( string operationId )

Creates a new instance of Operation to be executed on all uploaded files in the current batch.

Parameters

operationId The operation id.

Returns: A new Operation instance.

Definition at line 67 of file Batch.cs.

Batch NuxeoClient.Wrappers.Batch.SetClient ( Client client )

Sets the Nuxeo Client instance through which the requests for this batch will be made.

Parameters

client The Nuxeo Client instance.

Returns: The current Batch instance.

Definition at line 54 of file Batch.cs.

async Task<Batch> NuxeoClient.Wrappers.Batch.Upload ( UploadJob job )

Executes a non-chnked UploadJob.

Parameters

job	The UploadJob to be executed.

Returns: A new and updated Batch instance of the current batch.

Definition at line 79 of file Batch.cs.

async Task<Batch> NuxeoClient.Wrappers.Batch.UploadChunk ( UploadJob job )

Executes a chunked UploadJob.

Parameters

job	The UploadJob to be executed.

Returns: A new and updated Batch instance of the current batch.

Definition at line 94 of file Batch.cs.

Property Documentation

string NuxeoClient.Wrappers.Batch.Endpoint

get

Gets the endpoint of the batch.

Definition at line 40 of file Batch.cs.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation