|
| 1 | +--- |
| 2 | +uid: Plugins.Essentials.MainThread |
| 3 | +--- |
| 4 | + |
| 5 | +# App Permissions |
| 6 | + |
| 7 | +The Permissions API in Prism.Plugin.Essentials allows you to request and check permissions across Android, iOS, MacCatalyst and WinUI on both .NET MAUI and Uno Platform. As with other API's in Prism.Essentials this is automatically registered when Registering Prism Essentials. |
| 8 | + |
| 9 | +## Getting Started |
| 10 | + |
| 11 | +To use the Permissions Manager you can inject the `IPermissionsManager` into your services or ViewModels. |
| 12 | + |
| 13 | +```cs |
| 14 | +public class MyViewModel(IPermissionsManager permissions) : BindableBase |
| 15 | +{ |
| 16 | +} |
| 17 | +``` |
| 18 | + |
| 19 | +To check the state of a given permission you simply need to pass the permission type to the Permission Manager's Check or Request method like: |
| 20 | + |
| 21 | +```cs |
| 22 | +var status = await permissions.CheckStatusAsync<LocationAlways>(); |
| 23 | + |
| 24 | +if (status != PermissionStatus.NotSupported && status != PermissionStatus.Granted) |
| 25 | +{ |
| 26 | + status = await permissions.RequestAsync<LocationAlways>(); |
| 27 | +} |
| 28 | +``` |
| 29 | + |
| 30 | +A permission status of `NotSupported` may be returned when the underlying platform does not require authorization for a specific permission. |
| 31 | + |
| 32 | +## Supported Permissions |
| 33 | + |
| 34 | +| Permission | Android | iOS | MacCatalyst | WinUI | |
| 35 | +|------------|:-------:|:---:|:-----------:|:-----:| |
| 36 | +| Battery |  |  |  |  | |
| 37 | +| Bluetooth |  |  |  |  | |
| 38 | +| CalendarRead |  |  |  |  | |
| 39 | +| CalendarWrite |  |  |  |  | |
| 40 | +| Camera |  |  |  |  | |
| 41 | +| ContactsRead |  |  |  |  | |
| 42 | +| ContactsWrite |  |  |  |  | |
| 43 | +| Flashlight |  |  |  |  | |
| 44 | +| LaunchApp |  |  |  |  | |
| 45 | +| LocationAlways |  |  |  |  | |
| 46 | +| LocationWhenInUse |  |  |  |  | |
| 47 | +| Maps |  |  |  |  | |
| 48 | +| Media |  |  |  |  | |
| 49 | +| Microphone |  |  |  |  | |
| 50 | +| NearbyWifiDevices |  |  |  |  | |
| 51 | +| NetworkState |  |  |  |  | |
| 52 | +| Phone |  |  |  |  | |
| 53 | +| Photos |  |  |  |  | |
| 54 | +| PhotosAddOnly |  |  |  |  | |
| 55 | +| PostNotifications |  |  |  |  | |
| 56 | +| Reminders |  |  |  |  | |
| 57 | +| Sensors |  |  |  |  | |
| 58 | +| Sms |  |  |  |  | |
| 59 | +| Speech |  |  |  |  | |
| 60 | +| StorageRead |  |  |  |  | |
| 61 | +| StorageWrite |  |  |  |  | |
| 62 | +| Vibrate |  |  |  |  | |
0 commit comments