<permission>

(Optional) The privileges (also known as capabilities, user actions, or actions) the application requests from the OS

Parent elements:

<qnx>, <configuration>

Child elements:

None.

Description:

The <permission> element specifies the privileges (also known as capabilities, user actions, or actions) the application requests from the OS.

Content:

A PCDATA value representing the permissions granted to your application. The following identifiers specify the user permissions that can be granted to an application:

Functionality or capability Permission element value Description Permission availability

BlackBerry Messenger

bbm_connect

Allows the app to connect to BlackBerry Messenger (BBM). This permission also allows the app to view contact lists and user profiles, invite BBM contacts to download the app, initiate BBM chats and share content from within the app, and stream data between apps in real time.

BlackBerry 10.0.0 and later

Calendar

access_pimdomain_calendars

Allows the app to access the calendar on the device. This permission is required to view, add, and delete calendar appointments.

BlackBerry 10.0.0 and later

Camera

use_camera

Allows the app to access any of the data coming from cameras on the device. This permission is required for an app to take pictures, record video, and use the flash on the device.

BlackBerry 10.0.0 and later

Capture Screen

use_camera_desktop

Allows the app to take screen shots or videos of the user's screen.

BlackBerry 10.2.0 and later

Contacts

access_pimdomain_contacts

Allows the app to access to the contacts stored on the device. This permission is required to view, create, and delete contacts on the device and SIM card.

BlackBerry 10.0.0 and later

Control Notification Settings

access_notify_settings_control
Allows the app to modify global notification settings. Apps only have permission to read their own notification settings.

This permission does not appear on the Applications tab in the IDE. You must add the permission manually on the Source tab.

BlackBerry 10.2.0 and later

Device Identifying Information

read_device_identifying_information

Allows the app to access unique device identifiers such as the PIN and serial number. This permission also allows you to access SIM card information on the device.

BlackBerry 10.1.0 and later

Email and PIN Messages

access_pimdomain_messages

Allows the app to access the email and PIN messages stored on the device. This permission is required to view, create, send, and delete email and PIN messages.

BlackBerry 10.0.0 and later

Gamepad

use_gamepad

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

BlackBerry 10.0.0 and later

GPS Location (Deprecated)

read_geolocation

Deprecated. Use the Location (access_location_services) permission instead. This permission previously allowed access to the current GPS location of the device.

This permission does not appear in the Application tab in the IDE. You must add the permission manually in the Source tab.

Deprecated in BlackBerry 10.2.0. Available BlackBerry 10.0.0 and later

Hub Accounts

_sys__manage_pimdomain_external_accounts

Allows the app to create its own custom account that’s accessible in the BlackBerry Hub. You must request that BlackBerry allows your developer account to sign your app to use this restricted permission. To request access to use this permission, complete the App Permissions Request form.

This permission does not appear on the Application tab in the IDE. You must add the permission manually on the Source tab.

BlackBerry 10.2.0 and later

Hub Integration

_sys_access_pim_unified

Allows the app to integrate with the BlackBerry Hub. With this permission, apps can create data and manage data in the BlackBerry Hub. You must request that BlackBerry allows your developer account to sign your app to use this restricted permission. To request access to use this permission, complete the App Permissions Request form.

For the best user experience, it’s recommended that you implement integration with the BlackBerry Hub in a headless app, preferably integrated with the Push Service. This approach helps to ensure that incoming data is updated in the BlackBerry Hub even when your app is not running and to ensure minimal impact on battery life.

This permission does not appear on the Application tab in the IDE. You must add the permission manually on the Source tab.

BlackBerry 10.2.0 and later

Internet

access_internet

Allows the app to use an Internet connection from a Wi-Fi, wired, or other connection. This permission is required to access a destination that is not local on the user's device.

BlackBerry 10.0.0 and later

Location

access_location_services

Allows the app to access the device's current location and access locations saved on the device. This permission is required to access to geolocation data, information for geofencing, cell tower information, Wi-Fi data, and Cascades Places.

BlackBerry 10.0.0 and later

Microphone

record_audio

Allows the app to access the audio stream from the microphone on the device.

BlackBerry 10.0.0 and later

My Contact Info

read_personally_identifiable_information

Allows the app to 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.

BlackBerry 10.0.0 and later

Narrow Swipe Up

narrow_landscape_exit

Allows the app, within a landscape orientation (typically games), to use the corner regions for menus and virtual gamepads. This permission reduces the region of the home swipe up gesture to occur only in the middle edge of the bottom of the bezel instead of a full-length swipe. Use this permission to prevent the app from inadvertently going into the background when the corner regions are swiped.

This permission does not appear on the Application tab in the IDE. You must add the permission manually on the Source tab.

BlackBerry 10.0.0 and later

Notebooks

access_pimdomain_notebooks

Allows the app to access the content stored in the notebooks on the device. This permission is required to view, add, and delete entries and content from notebooks.

BlackBerry 10.0.0 and later

Phone

access_phone

Allows the app to 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.

BlackBerry 10.0.0 and later

Phone Control

control_phone

Allows the app to combine two calls together, end a call, and use the dial pad during a call.

BlackBerry 10.2.0 and later

Post Notifications

post_notification

Allows the app to post notifications. This permission does not require the user to grant your app access and is granted by the OS when requested.

BlackBerry 10.0.0 and later

Push

_sys_use_consumer_push

Allows the app to use the BlackBerry Push Service with the BlackBerry Internet Service. This permission allows an app to receive and request push messages. To use the Push Service with the BlackBerry Internet Service, you must register with BlackBerry. When you register, you receive a confirmation email message that contains information that the application needs to receive and request push messages. For more information about registering, see Push Service.

If you're using the Push Service with the BlackBerry Enterprise Server or the BlackBerry Device Service, you do not need to register with BlackBerry, and you must not add the Push permission for your app.

BlackBerry 10.0.0 and later

Run as Active Frame

run_when_backgrounded

Allows the app to perform background processing. Without this permission, the app will be stopped when the user switches focus to another app. Use this permission sparingly and only when your app must perform processing in the background.

This permission is useful for apps that play music or manage downloads. Apps that use this permission are rigorously reviewed for acceptance to the BlackBerry World storefront for their use of battery power on a device.

BlackBerry 10.0.0 and later

Run in Background

_sys_run_headless

Allows the app to 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 BlackBerry World storefront.

This permission does not appear on the Application tab in the IDE. You must add the permission manually using on the Source tab.

BlackBerry 10.2.0 and later

Run in Background Continuously

_sys_headless_nostop

Allows the app to run in the background at all times. You must request access before your app can run as a long-running headless app. To request access to use this permission, complete the App Permissions Request form.

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

This permission does not appear on the Application tab in the IDE. You must add the permission manually on the Source tab.

BlackBerry 10.2.0 and later

Shared Files

access_shared

Allows the app to read and write the files that are shared between all apps on the device. This permission allows the app to access pictures, music, documents, and other files that are stored on the user's device, at a remote storage provider, on a media card, or in the cloud.

BlackBerry 10.0.0 and later

Text Messages

access_sms_mms

Access the text messages stored on the device. This permission is required for your app to view, create, send, receive, and delete text messages..

BlackBerry 10.0.0 and later

Wi-Fi Connection

access_wifi_public

Allows the app to 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 the authentication to a Wi-Fi Hotspot. This permission does not 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. It's not necessary to configure this permission if you only want to retrieve or query information about existing Wi-Fi connections.

This permission does not appear on the Application tab in the IDE. You must add the permission manually on the Source tab.

BlackBerry 10.2.0 and later

Attributes:

Name Description Values Default
system (Optional) Specifies the action is a system action and not a user action. The default value is false. Examples of system actions you can use are run_native (run the app using OS runtime) run_air_native (run the app using Adobe AIR runtime).

These actions are added implicitly to the BAR file manifest by the packager when it detects an application type that requires them.

true, false false

Example:

<qnx>
...
...
   <permission system="true">run_native</permission>
   <permission system="false">access_shared</permission>
   <permission system="false">record_audio</permission>
...
</qnx>
          

Last modified: 2013-12-21

comments powered by Disqus