react-native-permissions

What is react-native-permissions?

The react-native-permissions package is a library for handling permissions in React Native applications. It provides a unified API to request and check permissions for various device features such as location, camera, microphone, and more.

What are react-native-permissions's main functionalities?

Requesting Permissions

This feature allows you to request specific permissions from the user. In this example, the code requests camera permission on an Android device.

import { request, PERMISSIONS } from 'react-native-permissions';

async function requestCameraPermission() {
  const result = await request(PERMISSIONS.ANDROID.CAMERA);
  console.log(result);
}

Checking Permissions

This feature allows you to check the current status of a specific permission. The example checks if the camera permission is granted on an Android device.

import { check, PERMISSIONS, RESULTS } from 'react-native-permissions';

async function checkCameraPermission() {
  const result = await check(PERMISSIONS.ANDROID.CAMERA);
  if (result === RESULTS.GRANTED) {
    console.log('Camera permission granted');
  } else {
    console.log('Camera permission not granted');
  }
}

Open App Settings

This feature allows you to open the app settings so the user can manually grant permissions. The example demonstrates how to open the app settings.

import { openSettings } from 'react-native-permissions';

function openAppSettings() {
  openSettings().catch(() => console.warn('Cannot open settings'));
}

Other packages similar to react-native-permissions

react-native-location

The react-native-location package provides location services for React Native applications. It allows you to request and check location permissions, as well as get the current location of the device. Compared to react-native-permissions, it is more focused on location-specific functionalities.

react-native-geolocation-service

The react-native-geolocation-service package is another library for handling geolocation in React Native apps. It offers more accurate and reliable location services compared to the default React Native geolocation API. While it focuses on geolocation, react-native-permissions provides a broader range of permission management.

react-native-contacts

The react-native-contacts package allows you to access and manage the device's contact list. It includes functionalities for requesting contact permissions, reading contacts, and adding new contacts. This package is specialized for contact management, whereas react-native-permissions covers a wider array of permissions.

README

React Native Permissions

Check user permissions (iOS only)

##What Some iOS features require the user to grant permission before you can access them.

This library lets you check the current status of those permissions. (Note: it doesn't prompt the user, just silently checks the permission status)

The current supported permissions are:

• Location
• Camera
• Microhone
• Photos
• Contacts
• Event
• Bluetooth (Peripheral role. Don't use for Central only)
• RemoteNotifications (Push Notifications)

####Example

const Permissions = require('react-native-permissions');

//....
  componentDidMount() {
    Permissions.locationPermissionStatus()
    .then(response => {
      if (response == Permissions.StatusUndetermined) {
        console.log("Undetermined");
      } else if (response == Permissions.StatusDenied) {
        console.log("Denied");
      } else if (response == Permissions.StatusAuthorized) {
        console.log("Authorized");
      } else if (response == Permissions.StatusRestricted) {
        console.log("Restricted");
      }
    });
  }
//...

####API

As shown in the example, methods return a promise with the authorization status as an int. You can compare them to the following statuses: StatusUndetermined, StatusDenied, StatusAuthorized, StatusRestricted

locationPermissionStatus() - checks for access to the user's current location. Note: AuthorizedAlways and AuthorizedWhenInUse both return StatusAuthorized

cameraPermissionStatus() - checks for access to the phone's camera

microphonePermissionStatus() - checks for access to the phone's microphone

photoPermissionStatus() - checks for access to the user's photo album

contactsPermissionStatus() - checks for access to the user's address book

eventPermissionStatus(eventType) - requires param eventType; either reminder or event. Checks for access to the user's calendar events and reminders

bluetoothPermissionStatus() - checks the authorization status of the CBPeripheralManager (for sharing data while backgrounded). Note: Don't use this if you're only using CBCentralManager

notificationPermissionStatus() - checks if the user has authorized remote push notifications. Note: Apple only tells us if notifications are authorized or not, not the exact status. So this promise only returns StatusUndetermined or StatusAuthorized. You can determine if StatusUndetermined is actually StatusRejected by keeping track of whether or not you've already asked the user for permission.

##Setup

npm install --save react-native-permissions

###iOS

• Run open node_modules/react-native-permissions
• Drag ReactNativePermissions.xcodeproj into the Libraries group of your app's Xcode project
• Add libReactNativePermissions.a to `Build Phases -> Link Binary With Libraries.