File

Important! This page is auto-generated from the comments in the source files. All changes will be overwritten! If you are looking to contribute, modify the comment in the corresponding source file instead.

Table of Contents

• Constructor
• Properties
  • id
  • name
  • type
  • size
  • origSize
  • loaded
  • percent
  • status
  • lastModifiedDate
• Methods
  • getNative()
  • getSource()
  • destroy()

Constructor

### [File(file)](/moxiecode/plupload/blob/master/src\plupload.js#L2228 "Defined at: src\plupload.js:2228")

Constructs a new file instance.

Arguments

• file Object
  Object containing file properties
  • name String
    Name of the file.
  • size Number
    File size.

## Properties ### [id](/moxiecode/plupload/blob/master/src\plupload.js#L2245 "Defined at: src\plupload.js:2245") #####

File id this is a globally unique id for the specific file.

### [name](/moxiecode/plupload/blob/master/src\plupload.js#L2253 "Defined at: src\plupload.js:2253") #####

File name for example "myfile.gif".

### [type](/moxiecode/plupload/blob/master/src\plupload.js#L2261 "Defined at: src\plupload.js:2261") #####

File type, e.g image/jpeg

### [size](/moxiecode/plupload/blob/master/src\plupload.js#L2269 "Defined at: src\plupload.js:2269") #####

File size in bytes (may change after client-side manupilation).

### [origSize](/moxiecode/plupload/blob/master/src\plupload.js#L2277 "Defined at: src\plupload.js:2277") #####

Original file size in bytes.

### [loaded](/moxiecode/plupload/blob/master/src\plupload.js#L2285 "Defined at: src\plupload.js:2285") #####

Number of bytes uploaded of the files total size.

### [percent](/moxiecode/plupload/blob/master/src\plupload.js#L2293 "Defined at: src\plupload.js:2293") #####

Number of percentage uploaded of the file.

### [status](/moxiecode/plupload/blob/master/src\plupload.js#L2301 "Defined at: src\plupload.js:2301") #####

Status constant matching the plupload states QUEUED, UPLOADING, FAILED, DONE.

### [lastModifiedDate](/moxiecode/plupload/blob/master/src\plupload.js#L2310 "Defined at: src\plupload.js:2310") #####

Date of last modification.

## Methods ### [getNative()](/moxiecode/plupload/blob/master/src\plupload.js#L2327 "Defined at: src\plupload.js:2327") #####

Returns native window.File object, when it's available.

### [getSource()](/moxiecode/plupload/blob/master/src\plupload.js#L2338 "Defined at: src\plupload.js:2338") #####

Returns mOxie.File - unified wrapper object that can be used across runtimes.

### [destroy()](/moxiecode/plupload/blob/master/src\plupload.js#L2351 "Defined at: src\plupload.js:2351") #####

Destroys plupload.File object.