README.md

PermissionsKit

Universal API for request permission and get its statuses — available .authorized, .denied & .notDetermined.

iOS Dev Community

Navigate

• Permissions
• Installation
  • Swift Package Manager
  • CocoaPods
  • Why Modules
• Usage
  • Request Permission
  • Get Status Permission
• Keys in Info.plist
  • Localisations
• Apps Using

Permissions

Icon	Permission	Key for Info.plist	Get Status	Make Request
	Bluetooth	NSBluetoothAlwaysUsageDescription, NSBluetoothPeripheralUsageDescription	✅	✅
	Calendar	NSCalendarsUsageDescription, NSCalendarsFullAccessUsageDescription, NSCalendarsWriteOnlyAccessUsageDescription	✅	✅
	Camera	NSCameraUsageDescription	✅	✅
	Contacts	NSContactsUsageDescription	✅	✅
	FaceID	NSFaceIDUsageDescription	☑️	✅
	Health	NSHealthUpdateUsageDescription, NSHealthShareUsageDescription	✅	✅
	Location	NSLocationAlwaysAndWhenInUseUsageDescription NSLocationWhenInUseUsageDescription	✅	✅
	Media Library	NSAppleMusicUsageDescription	✅	✅
	Microphone	NSMicrophoneUsageDescription	✅	✅
	Motion	NSMotionUsageDescription	✅	✅
	Notification		✅	✅
	Photo Library	NSPhotoLibraryUsageDescription, NSPhotoLibraryAddUsageDescription	✅	✅
	Reminders	NSRemindersUsageDescription, NSRemindersFullAccessUsageDescription	✅	✅
	Siri	NSSiriUsageDescription	✅	✅
	Speech Recognizer	NSSpeechRecognitionUsageDescription	✅	✅
	Tracking	NSUserTrackingUsageDescription	✅	✅

Installation

Ready to use on iOS 12+. Supports iOS, macOS, visionOS, tvOS & watchOS. Working with UIKit and SwiftUI.

Swift Package Manager

In Xcode go to Project -> Your Project Name -> Package Dependencies -> Tap Plus. Insert url:

https://github.com/sparrowcode/PermissionsKit

Next, choose the permissions that you need. But don't add all of them, because apple will reject app. Or adding it to the dependencies of your Package.swift:

dependencies: [
    .package(url: "https://github.com/sparrowcode/PermissionsKit", .upToNextMajor(from: "11.0.0"))
]

and choose valid targets.

CocoaPods:

This is an outdated way. I advise you to use SPM. However, I will continue to support Cocoapods for some time.

Cocoapods Installation

CocoaPods is a dependency manager. For usage and installation instructions, visit their website. To integrate using CocoaPods, specify it in your Podfile:

pod 'PermissionsKit/NotificationPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'

Due to Apple's new policy regarding permission access you need to specifically define what kind of permissions you want to access using subspecs.

pod 'PermissionsKit/CameraPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/ContactsPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/CalendarPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/PhotoLibraryPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/NotificationPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/MicrophonePermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/RemindersPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/SpeechRecognizerPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/LocationPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/MotionPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/MediaLibraryPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/BluetoothPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/TrackingPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/FaceIDPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/SiriPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'
pod 'PermissionsKit/HealthPermission', :git => 'https://github.com/sparrowcode/PermissionsKit'

Why Modules

If you put all your code into one package and compile it, the Apple Review Team will see a lot of calls to the permissions API. Most likely, they will ask you to provide a valid reason for why you really need those permissions. Using modules allows you to compile only the parts of the code that are actually in use. Just select only what you need.

Warning

Import only the permissions you really need.

Request Permission

import PermissionsKit
import NotificationPermission

PermissionsKit.Permission.notification([.alert, .badge, .sound]).request {

}

Get Status Permission

import PermissionsKit
import NotificationPermission

let authorized = Permission.notification.authorized

Warning

For FaceID permission no way detect if request .authorized or .notDetermined accurate. Status .denied detect well. For now for both states return .notDetermined.

Keys in Info.plist

You need to add some strings to the Info.plist file with descriptions per Apple's requirements. You can get a plist of keys for permissions as follows:

let key = Permission.bluetooth.usageDescriptionKey

Note

Do not use the description as the name of the key. Xcode can't build this.

Localisation

If you use xliff localization export, keys will be create automatically. If you prefer do the localization file manually, you need to create InfoPlist.strings, select languages on the right side menu and add keys as keys in plist-file. See:

"NSCameraUsageDescription" = "Here description of usage camera";

Apps Using

If you use a PermissionsKit, add your app via Pull Request.