Available permissions

Be sure to check the API reference for the classes that you're working with to determine which permissions you need to add.

BlackBerry Messenger

Connect to BlackBerry Messenger (BBM). You can use this permission to access contact lists and user profiles, invite BBM contacts to download your app, initiate BBM chats and share content from within your app, and stream data between apps.

Element value Prompted Restricted Since
bbm_connect Yes No BlackBerry 10.0.0

Calendar

Access the calendar on the device. This access includes viewing, adding, and deleting calendar appointments.

Element value Prompted Restricted Since
access_pimdomain_calendars Yes No  BlackBerry 10.0.0

Camera

Access data that's received from the cameras on the device. With this permission, your app can take pictures, record videos, and use the flash.

Element value Prompted Restricted Since
use_camera Yes No  BlackBerry 10.0.0

Capture Screen

Take a screen shot or video of any information visible on the screen of the device. This permission also allows the app to share the user's screen.

Element value Prompted Restricted Since
use_camera_desktop Yes No  BlackBerry 10.2.0

Contacts

Access the contacts that are stored on the device. This access includes viewing, creating, and deleting contacts.

Element value Prompted Restricted Since
access_pimdomain_contacts Yes No  BlackBerry 10.0.0

Device Identifying Information

Access unique device identifiers, such as the PIN or the serial number. This permission also allows you to access SIM card information on the device.

Element value Prompted Restricted Since
read_device_identifying_ information Yes No  BlackBerry 10.1.0

Email and PIN Messages

Access the email and PIN messages that are stored on the device. This access includes viewing, creating, sending, and deleting messages.

Element value Prompted Restricted Since
access_pimdomain_messages Yes No  BlackBerry 10.0.0

Gamepad

Access gamepad functionality. This permission also indicates that the app has official gamepad support in the BlackBerry World storefront.

Element value Prompted Restricted Since
use_gamepad No No  BlackBerry 10.0.0

GPS Location

Read the current GPS location of the device.

This permission is deprecated. Use the Location (access_location_services) permission instead.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
read_geolocation Yes No

Deprecated: BlackBerry 10.2.0

Hub Accounts

Create a custom account that’s accessible in the BlackBerry Hub. BlackBerry must allow your developer account to sign your app to use this restricted permission. To use this permission, complete the App Permissions Request form.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
_sys__manage_pimdomain_ external_accounts No Yes  BlackBerry 10.2.0

Hub Integration

Integrate with the BlackBerry Hub. With this permission, your app can create and manage data in the BlackBerry Hub. BlackBerry must allow your developer account to sign your app to use this restricted permission. To use this permission, complete the App Permissions Request form.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

For more information, see Headless applications and Push Service.

For the best user experience, you should integrate with the BlackBerry Hub in a headless app, preferably integrated with the Push Service. This approach ensures that incoming data is updated in the BlackBerry Hub, even when your app is not running, with minimal impact on battery life.

Element value Prompted Restricted Since
_sys_access_pim_unified No Yes  BlackBerry 10.2.0

Internet

Use the Internet connection from a Wi-Fi, wired, or other type of connection to access locations that are not local on the device.

Element value Prompted Restricted Since
access_internet No No  BlackBerry 10.0.0

Location

Access the current location of the device, as well as locations that the user has saved.

Element value Prompted Restricted Since
access_location_services Yes No  BlackBerry 10.0.0

Microphone

Access the audio stream from the microphone on the device.

Element value Prompted Restricted Since
record_audio Yes No  BlackBerry 10.0.0

My Contact Info

Access user information on the device, such as the first name, last name, and BlackBerry ID username of the user currently associated with this device.

Element value Prompted Restricted Since
read_personally_identifiable_ information Yes No  BlackBerry 10.0.0

Narrow Swipe Up

Reduce the width of the region along the bottom bezel of the device that accepts swipe-up gestures. When you use this permission, swipe-up gestures are recognized in a more narrow area along the bottom bezel.

This behavior allows apps that run in landscape orientation, such as games, to use corner regions for menus and virtual gamepads and prevents the game from being sent to the background inadvertently.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
narrow_landscape_exit No No

 BlackBerry 10.0.0

Notebooks

Access the content that's stored in notebooks on the device. This access includes adding entries to, and deleting entries from, the notebooks.

Element value Prompted Restricted Since
access_pimdomain_notebooks Yes No  BlackBerry 10.0.0

Notification Control

Change global notification settings. Apps have permission to read their own notification settings.

Element value Prompted Restricted Since
access_notify_settings_control Yes No  BlackBerry 10.2.0

Personal network

Allows this app to use the personal network.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Due to the potential for misuse of the functionality associated with this permission, apps that use this permission are rigorously reviewed for acceptance to the BlackBerry World storefront.

Element value Prompted Restricted Since
_sys_gain_personal_networking_ group Yes Yes  BlackBerry 10.3.1

Phone

Determine when a user is on a phone call. This access also allows an app to access the phone number assigned to the device and send DTMF (Dual Tone Multi-Frequency) tones.

Element value Prompted Restricted Since
access_phone Yes No  BlackBerry 10.0.0

Phone Audio Overlay

Add audio to a phone call.

Element value Prompted Restricted Since
_sys_inject_voice Yes Yes  BlackBerry 10.3.0

Phone Call Details

View the status of phone calls that are in progress and the phone number of the remote party.

Element value Prompted Restricted Since
read_phonecall_details Yes No  BlackBerry 10.3.0

Phone Call Logs

View the logs of previous incoming or outgoing phone calls.

Element value Prompted Restricted Since
access_pimdomain_calllogs Yes No  BlackBerry 10.3.0

Phone Call No Prompt

Start an outgoing phone call without asking the user to confirm the phone call.

BlackBerry must allow your developer account to sign your app to use this restricted permission. To use this permission, complete the App Permissions Request form.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
_sys_start_phone_call Yes Yes  BlackBerry 10.3.0

Phone Control

Control the current phone call. This access includes ending a phone call and sending DTMF tones to the phone.

Element value Prompted Restricted Since
control_phone Yes No  BlackBerry 10.2.0

Phone Recording

Record phone calls. This access includes recording an ongoing phone call and saving the audio to a file.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
_sys_record_voice Yes Yes  BlackBerry 10.3.0

Post Notifications

Post notifications to the notification area of the device screen. This permission does not require the user to grant your app access.

Element value Prompted Restricted Since
post_notification No No  BlackBerry 10.0.0

Push

Access the Push Service to receive and request push messages.

To use the Push Service, you must register with BlackBerry. When you register, you receive a confirmation email message that contains information that your app needs to receive and request push messages. For more information about registering, visit the Push Service documentation.

If you're using the Push Service with BlackBerry Enterprise Service 10 or BlackBerry Device Service, you don't need to register with BlackBerry and you must not specify the Push permission for your app.

Element value Prompted Restricted Since
_sys_use_consumer_push No No  BlackBerry 10.0.0

Run as Active Frame

Perform background processing. Without this permission, your app stops all processing when the user changes focus to another app.

You should use this permission sparingly and only when your app must perform specific processing in the background. Apps that use this permission are rigorously reviewed for acceptance to the BlackBerry World storefront for their use of device battery power.

This permission is useful for apps that play music or manage downloads.

Element value Prompted Restricted Since
run_when_backgrounded No No  BlackBerry 10.0.0

Run in Background

Perform certain tasks in the background, without opening the app, for a short period of time.

Due to the potential for misuse of the functionality associated with this permission, apps that use this permission are rigorously reviewed for acceptance to the BlackBerry World storefront.

Element value Prompted Restricted Since
_sys_run_headless No No  BlackBerry 10.2.0

Run in Background Continuously

Run in the background as a long-running headless app.

Element value Prompted Restricted Since
_sys_headless_nostop No No  BlackBerry 10.2.0

Shared Files

Read and write files that are shared between all apps on the device. With this permission, your app can access pictures, music, documents, and other files that are stored on the user's device, at a remote storage provider, or on a media card.

Element value Prompted Restricted Since
access_shared Yes No  BlackBerry 10.0.0

Smart Card

Encrypt, decrypt, sign, and verify data using a smart card.

This permission is restricted. To use this permission, send an email to SCRinquiries@blackberry.com.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
_sys_access_smartcard_api No Yes  BlackBerry 10.3.0

Smart Card Driver

Allow third-party smart card drivers and smart card reader drivers to integrate with the Smart Card service. This permission is restricted. To use this permission, send an email to SCRinquiries@blackberry.com.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
_sys_smart_card_driver No Yes  BlackBerry 10.3.0

Smart Card Extended

Use APDU (Application Protocol Data Unit) for custom commands. This permission is restricted. To use this permission, send an email to SCRinquiries@blackberry.com.

This permission is not available as a check box on the Application tab of the bar-descriptor.xml file.

Element value Prompted Restricted Since
_sys_access_extended_smart_ card_functionality No Yes  BlackBerry 10.3.0

Text Messages

Access the text messages that are stored on the device. This access includes viewing, creating, sending, and deleting text messages.

Element value Prompted Restricted Since
access_sms_mms Yes No  BlackBerry 10.0.0

Wi-Fi Connection

Receive Wi-Fi event notifications such as Wi-Fi scan results or changes in the Wi-Fi connection state.

This permission also allows limited Wi-Fi control for hotspot aggregator applications that manage network selection and authentication to a hotspot.

This permission doesn't allow the app to force a connection to a specific network profile when there are other available networks that have a higher priority configured on the device. If you want to retrieve or query information about existing Wi-Fi connections, it's not necessary to configure this permission.

Element value Prompted Restricted Since
access_wifi_public No No  BlackBerry 10.2.0