Cloud

Registers an after delete function.

Available in Cloud Code only.

If you want to use afterDelete for a predefined class in the Parse JavaScript SDK (e.g. Parse.User), you should pass the class itself and not the String for arg1.

Parse.Cloud.afterDelete('MyCustomClass', (request) => {
  // code here
})

Parse.Cloud.afterDelete(Parse.User, (request) => {
  // code here
})

Registers an after save function.

Available in Cloud Code only.

If you want to use afterSave for a predefined class in the Parse JavaScript SDK (e.g. Parse.User), you should pass the class itself and not the String for arg1.

Parse.Cloud.afterSave('MyCustomClass', function(request) {
  // code here
})

Parse.Cloud.afterSave(Parse.User, function(request) {
  // code here
})

Registers an after save file function.

Available in Cloud Code only.

Example: creating a new object that references this file in a separate collection

Parse.Cloud.afterSaveFile(async ({ file, user }) => {
  const fileObject = new Parse.Object('FileObject');
  fileObject.set('metadata', file.metadata());
  fileObject.set('tags', file.tags());
  fileObject.set('name', file.name());
  fileObject.set('createdBy', user);
  await fileObject.save({ sessionToken: user.getSessionToken() });
});

Registers an before delete function.

Available in Cloud Code only.

If you want to use beforeDelete for a predefined class in the Parse JavaScript SDK (e.g. Parse.User), you should pass the class itself and not the String for arg1.

Parse.Cloud.beforeDelete('MyCustomClass', (request) => {
  // code here
})

Parse.Cloud.beforeDelete(Parse.User, (request) => {
  // code here
})

Registers an before save function.

Available in Cloud Code only.

If you want to use beforeSave for a predefined class in the Parse JavaScript SDK (e.g. Parse.User), you should pass the class itself and not the String for arg1.

Parse.Cloud.beforeSave('MyCustomClass', (request) => {
  // code here
})

Parse.Cloud.beforeSave(Parse.User, (request) => {
  // code here
})

Registers an before save file function. A new Parse.File can be returned to override the file that gets saved. If you want to replace the rquesting Parse.File with a Parse.File that is already saved, simply return the already saved Parse.File. You can also add metadata to the file that will be stored via whatever file storage solution you're using.

Available in Cloud Code only.

Example: Adding metadata and tags

Parse.Cloud.beforeSaveFile(({ file, user }) => {
  file.addMetadata('foo', 'bar');
  file.addTag('createdBy', user.id);
});

Example: replacing file with an already saved file

Parse.Cloud.beforeSaveFile(({ file, user }) => {
  return user.get('avatar');
});

Example: replacing file with a different file

Parse.Cloud.beforeSaveFile(({ file, user }) => {
  const metadata = { foo: 'bar' };
  const tags = { createdBy: user.id };
  const newFile = new Parse.File(file.name(), <some other file data>, 'text/plain', metadata, tags);
  return newFile;
});

Defines a Cloud Function.

Available in Cloud Code only.

Gets data for the current set of cloud jobs.

Gets job status by Id

Makes an HTTP Request.

Available in Cloud Code only.

By default, Parse.Cloud.httpRequest does not follow redirects caused by HTTP 3xx response codes. You can use the followRedirects option in the Parse.Cloud.HTTPOptions object to change this behavior.

Sample request:

Parse.Cloud.httpRequest({
  url: 'http://www.example.com/'
}).then(function(httpResponse) {
  // success
  console.log(httpResponse.text);
},function(httpResponse) {
  // error
  console.error('Request failed with response code ' + httpResponse.status);
});

Defines a Background Job.

Available in Cloud Code only.

Makes a call to a cloud function.

Starts a given cloud job, which will process asynchronously.