Skip to content

Documentation for deleting files (improvement) #791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Dec 7, 2020
Merged

Documentation for deleting files (improvement) #791

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d61b9db
Merge commit 'e129790ed587819ecfcaed59fc7ff90ec6ffcfa1' into gh-pages
mtrezza Sep 6, 2019
9cc311c
Merge remote-tracking branch 'upstream/gh-pages' into gh-pages
mtrezza Nov 15, 2019
d425b11
Merge commit 'cc489df4a3d8544a52148c079ecaee3d1762108d' into gh-pages
mtrezza Jan 9, 2020
ddb5cb1
Merge remote-tracking branch 'upstream/gh-pages' into gh-pages
mtrezza Apr 18, 2020
3cf6398
Merge remote-tracking branch 'upstream/gh-pages' into gh-pages
mtrezza Jul 11, 2020
5e6c8fa
Merge remote-tracking branch 'upstream/gh-pages' into gh-pages
mtrezza Nov 17, 2020
b62ab67
improved JS doc for deleting file
mtrezza Nov 17, 2020
6a63e8d
removed required reference to delete file
mtrezza Nov 18, 2020
c320d7e
changed bullet point to headline
mtrezza Nov 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions _includes/js/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,20 +113,17 @@ Parse.Cloud.httpRequest({ url: profilePhoto.url() }).then(function(response) {

## Deleting Files

You can delete files that are referenced by objects using the [REST API]({{ site.baseUrl }}/rest/guide/#deleting-files). You will need to provide the master key in order to be allowed to delete a file.

If your files are not referenced by any object in your app, it is not possible to delete them through the REST API.

Alternatively, starting with Parse Server 4.2.0, you can delete files using cloud code.
You can delete files that are referenced by objects using the `destroy` method. The master key is required to delete a file.

```javascript
Parse.Cloud.beforeDelete('Profile', async (req) => {
const profile = req.object;
const profilePhoto = profile.get("photoFile");
await profilePhoto.destroy({ useMasterKey: true })
});
const profilePhoto = profile.get("photoFile");
await profilePhoto.destroy({ useMasterKey: true });
```

#### Parse Server <4.2.0

Use the [REST API]({{ site.baseUrl }}/rest/guide/#deleting-files) to delete a file.

## Adding Metadata and Tags

Adding Metadata and Tags to your files allows you to add additional bits of data to the files that are stored within your storage solution (i.e AWS S3).
Expand Down