react-native-delete-media

react-native-delete-media is a react native module used to delete media on android using the new scoped storage. It only supports Android.

It uses the native MediaStore.createDeleteRequest function to launch the android activity responsible for asking the user permission to delete a media file.

Getting started

Installing

$ yarn add react-native-delete-media

or

$ npm install react-native-delete-media

Library configuration

1. Append the following lines to android/settings.gradle:

   include 'react-native-delete-media'
   project(':react-native-delete-media').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-delete-media/android')

2. Insert the following lines inside the dependencies block in android/app/build.gradle:

     implementation project(':react-native-delete-media')

3. Add the following lines to your imports in android/app/src/main/java/com/[projectname]/MainActivity.java:

       import com.rtndeletemedia.DeleteMediaModule;
       import android.os.Bundle;

4. Create the OnCreate method in MainActivity.java, if you already have an OnCreate function just add the init line:

   @Override
   public void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       DeleteMediaModule.init(this);
   }

   Your MainActivity.java file should look like this:

   import com.facebook.react.ReactActivity;
   import com.facebook.react.ReactActivityDelegate;
   import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint;
   import com.facebook.react.defaults.DefaultReactActivityDelegate;
   
   import com.rtndeletemedia.DeleteMediaModule;
   import android.os.Bundle;
   
   public class MainActivity extends ReactActivity {
   
   @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         DeleteMediaModule.init(this);
     }
   ...
   ...
   }
   

5. Make sure to rebuild using yarn android.

Linking

This module was created using the new Turbo Native Modules. It needs to have the New Architecture enabled in the android/gradle.properties file.

If you're project is not using New Architecture, you'll need to link the library manually.

To do so:

1. Follow the steps in the Library configuration section.

2. In the android/app/src/main/java/com/[projectname]/MainApplication.java file, add:

   • import com.rtndeletemedia.DeleteMediaPackage; to the list of imports at the top of the file.

   • packages.add(new DeleteMediaPackage()); to the getPackages() method.

Note: If you the this error while trying to use the module [TypeError: Cannot read property 'deletePhotos' of null] you probably need to manually link it.

Permissions

You will need to add the WRITE_EXTERNAL_STORAGE permission to your android manifest

<manifest xmlns:android="http://schemas.android.com/apk/res/android">

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

    <application
      ...
    </application>
</manifest>

And make sure to request it before calling any functions from this module.

Usage

Here is a simple example of using the library.

import { PermissionsAndroid, Platform } from "react-native";
import { DeleteMedia, ErrorCodes } from "react-native-delete-media";

async function hasAndroidPermission() {
  const permission = PermissionsAndroid.PERMISSIONS.WRITE_EXTERNAL_STORAGE;

  const hasPermission = await PermissionsAndroid.check(permission);
  if (hasPermission) {
    return true;
  }

  const status = await PermissionsAndroid.request(permission);
  return status === "granted";
}

async function DeleteImage() {
  if (Platform.OS !== "android") {
    return;
  }

  if (!(await hasAndroidPermission())) {
    return;
  }

  const uri = "file:///storage/emulated/0/DCIM/Camera/photo.jpg";

  DeleteMedia.deletePhotos([uri])
    .then(() => {
      console.log("Image deleted");
    })
    .catch((e) => {
      const message = e.message;
      const code: ErrorCodes = e.code;

      switch (code) {
        case "ERROR_USER_REJECTED":
          console.log("Image deletion denied by user");
          break;
        default:
          console.log(message);
          break;
      }
    });
}

Methods

deletePhotos()

    DeleteMedia.deletePhotos(Array<string>);

This function asks the android OS to delete a list of media.

It takes in an array of uris strings. Theses strings must be valid uris to a local images or videos, such as file:///storage/emulated/0/DCIM/Camera/photo.jpg

The function will fail if at least one of the uris is not valid or is not found.

It returns a promise that resolves if all the media was deleted and rejects otherwise.

When rejected it returns an error object of type {code: ErrorCodes, message: string}.

The list of possible error codes is:

• "ERROR_WRITE_EXTERNAL_STORAGE_PERMISSION_NEEDED"

  Permission to write to external storage is not granted.

• "ERROR_URIS_NOT_FOUND"

  One or more uris are invalid or not found.

• "ERROR_USER_REJECTED"

  User rejected the delete operation.

• "ERROR_URIS_PARAMETER_NULL"

  List of uris passed to deletePhotos is undefined or null

• "ERROR_URIS_PARAMETER_INVALID"

  List of uris passed to deletePhotos is not valid, it should be an array of strings.

• "ERROR_MODULE_NOT_INITIALIZED"

  The module was not initialized correctly, please follow the steps in Library configuration

• "ERROR_UNEXPECTED"

  Unexpected error. Report it if encountered in Issues.