API Docs for:

Class Parse.File

A Parse.File is a local representation of a file that is saved to the Parse cloud.

Parse.File( name, data, type )
Parameters:
  • name <String>

    The file's name. This will be prefixed by a unique value once the file has finished saving. The file name must begin with an alphanumeric character, and consist of alphanumeric characters, periods, spaces, underscores, or dashes.

  • data <Array>

    The data for the file, as either: 1. an Array of byte value Numbers, or 2. an Object like { base64: "..." } with a base64-encoded String. 3. a File object selected with a file upload control. (3) only works in Firefox 3.6+, Safari 6.0.2+, Chrome 7+, and IE 10+. For example:

    var fileUploadControl = $("#profilePhotoFileUpload")[0];
    if (fileUploadControl.files.length > 0) {
    var file = fileUploadControl.files[0];
    var name = "photo.jpg";
    var parseFile = new Parse.File(name, file);
    parseFile.save().then(function() {
    // The file has been saved to Parse.
    }, function(error) {
    // The file either could not be read, or could not be saved to Parse.
    });
    }

  • type <String>

    Optional Content-Type header to use for the file. If this is omitted, the content type will be inferred from the name's extension.

String name( )

Gets the name of the file. Before save is called, this is the filename given by the user. After save is called, that name gets prefixed with a unique identifier.


Returns: <String>
Parse.Promise save( options )

Saves the file to the Parse cloud.

Parameters:
  • options <Object>

    A Backbone-style options object.


Returns: <Parse.Promise>

Promise that is resolved when the save finishes.

String url( )

Gets the url of the file. It is only available after you save the file or after you get the file from a Parse.Object.


Returns: <String>