Ninja Pokémon Master

    cordova-plugin-android-permissions

    1.1.5 • Public • Published

    Android Permission Cordova Plugin

    This plugin is designed to support Android's new permissions checking mechanism, and has been updated to include the newest permissions added in Android 13.

    The Android permissions checking mechanism changed starting in Android 6.0. In the past, permissions were granted by users when they decided to install the app. Now the permissions should be granted by users when they are using the app.

    Older Android plugins may not support this new approach or request the necessary permissions, but Cordova developers can work around this problem by using this permissions plugin to request the appropriate permissions prior to using the older plugin.

    As a convenience we support browser and iOS platforms as well, but this permissions plugin will simply reply that any permission checked or requested was granted.

    Installation

    cordova plugin add cordova-plugin-android-permissions

    ※ Support Android SDK >= 14

    Usage

    API

    var permissions = cordova.plugins.permissions;
    permissions.checkPermission(permission, successCallback, errorCallback);
    permissions.requestPermission(permission, successCallback, errorCallback);
    permissions.requestPermissions(permissions, successCallback, errorCallback);

    Deprecated API - still work now, will not support in the future.

    permissions.hasPermission(permission, successCallback, errorCallback);
    permissions.hasPermission(successCallback, errorCallback, permission);
    permissions.requestPermission(successCallback, errorCallback, permission);

    Permission Name

    Following the Android design. See Manifest.permission.

    // Example
    permissions.ACCESS_COARSE_LOCATION
    permissions.CAMERA
    permissions.GET_ACCOUNTS
    permissions.READ_CONTACTS
    permissions.READ_CALENDAR
    ...

    Examples

    var permissions = cordova.plugins.permissions;

    Quick check

    permissions.hasPermission(permissions.CAMERA, function( status ){
      if ( status.hasPermission ) {
        console.log("Yes :D ");
      }
      else {
        console.warn("No :( ");
      }
    });

    Quick request

    permissions.requestPermission(permissions.CAMERA, success, error);
    
    function error() {
      console.warn('Camera permission is not turned on');
    }
    
    function success( status ) {
      if( !status.hasPermission ) error();
    }

    Example multiple permissions

    var list = [
      permissions.CAMERA,
      permissions.GET_ACCOUNTS
    ];
    
    permissions.hasPermission(list, callback, null);
    
    function error() {
      console.warn('Camera or Accounts permission is not turned on');
    }
    
    function success( status ) {
      if( !status.hasPermission ) {
      
        permissions.requestPermissions(
          list,
          function(status) {
            if( !status.hasPermission ) error();
          },
          error);
      }
    }

    License

    Copyright (C) 2016 Jason Yang
    
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
    
       http://www.apache.org/licenses/LICENSE-2.0
    
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
    

    Install

    npm i cordova-plugin-android-permissions

    DownloadsWeekly Downloads

    14,546

    Version

    1.1.5

    License

    Apache 2.0

    Unpacked Size

    61.4 kB

    Total Files

    8

    Last publish

    Collaborators

    • jasonyang