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

Represents an upload job, used either by the Uploader and the Batch classes. And upload job might refer to the upload of a whole file or a chunk of a file. More...

Public Member Functions

 UploadJob (Blob blob)
 Creates a new UploadJob for the supplied blob . More...
 
UploadJob SetFileId (int fileId)
 Sets the id of the file to upload. More...
 
UploadJob SetChunkIndex (int chunkIndex)
 Sets the index of the chunk to upload. More...
 
UploadJob SetChunkCount (int chunkCount)
 Sets the number of total chunks to upload. More...
 
override string ToString ()
 Creates and returns a string representation of the current UploadJob object. More...
 

Properties

Blob Blob [get, protected set]
 Gets the Blob to upload. More...
 
int FileId [get, protected set]
 Gets the id of the file to upload. More...
 
int ChunkIndex = 0 [get, protected set]
 Gets the index of the chunk to upload. More...
 
int ChunkCount = 0 [get, protected set]
 Gets the total amount of chunks to upload; More...
 

Detailed Description

Represents an upload job, used either by the Uploader and the Batch classes. And upload job might refer to the upload of a whole file or a chunk of a file.

Definition at line 25 of file UploadJob.cs.

Constructor & Destructor Documentation

NuxeoClient.UploadJob.UploadJob ( Blob  blob)

Creates a new UploadJob for the supplied blob .

Parameters
blobThe Blob to be uploaded.

Definition at line 51 of file UploadJob.cs.

Member Function Documentation

UploadJob NuxeoClient.UploadJob.SetChunkCount ( int  chunkCount)

Sets the number of total chunks to upload.

Parameters
chunkCount
Returns
The current UploadJob instance.

Definition at line 83 of file UploadJob.cs.

UploadJob NuxeoClient.UploadJob.SetChunkIndex ( int  chunkIndex)

Sets the index of the chunk to upload.

Parameters
chunkIndex
Returns
The current UploadJob instance.

Definition at line 72 of file UploadJob.cs.

UploadJob NuxeoClient.UploadJob.SetFileId ( int  fileId)

Sets the id of the file to upload.

Parameters
fileIdThe id of the file.
Returns
The current UploadJob instance.

Definition at line 61 of file UploadJob.cs.

override string NuxeoClient.UploadJob.ToString ( )

Creates and returns a string representation of the current UploadJob object.

Returns
A string representation of the current UploadJob object.

Definition at line 93 of file UploadJob.cs.

Property Documentation

Blob NuxeoClient.UploadJob.Blob
getprotected set

Gets the Blob to upload.

Definition at line 30 of file UploadJob.cs.

int NuxeoClient.UploadJob.ChunkCount = 0
getprotected set

Gets the total amount of chunks to upload;

Definition at line 45 of file UploadJob.cs.

int NuxeoClient.UploadJob.ChunkIndex = 0
getprotected set

Gets the index of the chunk to upload.

Definition at line 40 of file UploadJob.cs.

int NuxeoClient.UploadJob.FileId
getprotected set

Gets the id of the file to upload.

Definition at line 35 of file UploadJob.cs.