10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_author.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | author
5 | The ID of the author's name that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_authorEmail.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | authorEmail
5 | The author's email of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_authorURL.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | authorURL
5 | The author's URL of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_copyright.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | copyright
5 | The copyright information of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_description.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | description
5 | The description of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_exit.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | exit()
5 | This function will cause the application to exit.
6 |
7 |
8 | Synopsis:
9 |
exit: function(){}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_id.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | id
5 | The ID of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_license.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | license
5 | The license of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_licenseURL.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | licenseURL
5 | The license URL of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_minimize.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | minimize()
5 | Minimizes the application window to a thumbnail and sends the user to the application switcher on the home screen. This will trigger the pause event.
6 |
7 |
8 | Synopsis:
9 |
minimize: function(){}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_name.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | name
5 | The name of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_orientation.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | orientation
5 | The current orientation of the BlackBerry device.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_unlockOrientation.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | unlockOrientation()
5 | This function will unlock the screen rotating if it was previously locked.
6 |
7 |
8 | Synopsis:
9 |
unlockOrientation: function(){}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_version.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | version
5 | The version of the BlackBerry WebWorks application that is specified in the config.xml file.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_app_windowState.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | windowState
5 | The current window state of the application. This will be equal to "fullscreen" when the application is considered to be fullscreen and should be running normally. It will have the value of "thumbnail" when the application has been sized smaller than fullscreen. It will be equal to "invisible" when the application's window is not visible to the user. This could be due to being positioned off the screen or when the LCD is turned off.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_connection_type.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | type
5 | The type of network connection that is being used by the application. Note that CELL_4G is always returned for cellular connection.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_identity.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Identity
5 | The Identity object contains information regarding the user's identity and accounts on a BlackBerry smartphone.
6 |
7 |
--------------------------------------------------------------------------------
/api/blackberry_identity_IMEI.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | IMEI
5 | Contains the IMEI number for the smartphone.
6 |
7 |
8 | Synopsis:
9 |
10 |
11 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/api/blackberry_invoke.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Invoke
5 | The Invoke object contains methods that interact with other applications.
6 |
7 |
On BlackBerry 10, the {@link blackberry.invoke.invoke} method will take arguments in the form of JavaScript object literal.
8 |
9 |
10 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_FILE_TRANSFER_COPY_RO.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILE_TRANSFER_COPY_RO
5 | Describes the file transfer mode where the file will be copied to the invoked application with read only privileges.
6 |
7 |
8 | Synopsis:
9 |
constant {String}
10 |
FILE_TRANSFER_COPY_RO : "COPY_RO"
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_FILE_TRANSFER_COPY_RW.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILE_TRANSFER_COPY_RW
5 | Describes the file transfer mode where the file will be copied to the invoked application with read and write privileges.
6 |
7 |
8 | Synopsis:
9 |
constant {String}
10 |
FILE_TRANSFER_COPY_RW : "COPY_RW"
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_FILE_TRANSFER_LINK.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILE_TRANSFER_LINK
5 | Describes the file transfer mode where the invoked application will receive a link to the file path provided. The permissions of the original file MUST include o+r. It o+w the sender must be the owner of the file.
6 |
7 |
8 | Synopsis:
9 |
constant {String}
10 |
FILE_TRANSFER_LINK : "LINK"
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_FILE_TRANSFER_PRESERVE.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILE_TRANSFER_PRESERVE
5 | Describes the file transfer mode where the provided URI is preserved as is. No box-2-box logic is applied.
6 |
7 |
8 | Synopsis:
9 |
{Sample - Invoking cards} https://github.com/blackberry/BB10-WebWorks-Samples/tree/master/invoke-card Sample that demonstrates how to use the BlackBerry Invoke Cards API [BlackBerry on GitHub]. Invoking cards as Share Targets} https://github.com/blackberry/BB10-WebWorks-Samples/tree/master/ShareTargets Sample that demonstrates how to use the BlackBerry Invoke Cards API [BlackBerry on GitHub].
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_CAMERA_MODE_FULL.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CAMERA_MODE_FULL
5 | Describes the full mode for camera which means photo,video and TimeShift.
6 |
7 |
8 | Synopsis:
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_CalendarComposerOptions_accountId.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | accountId
5 | The account ID of the account the composer should create the event for.
6 |
7 |
8 | Synopsis:
9 |
{Number}
10 |
accountId = 0
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_CalendarComposerOptions_body.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | body
5 | The the event notes that should be set when the composer is invoked.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_CalendarComposerOptions_startTime.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | startTime
5 | Represents the start time of the event. e.g: Mon Nov 26 12:30:17 2012
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
startTime = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_CalendarComposerOptions_subject.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | subject
5 | The the event subject that should be set when the composer is invoked.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
subject = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_CalendarComposerOptions_syncId.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | syncId
5 | The sync ID of the account for the calendar composer.
6 |
7 |
8 | Synopsis:
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_EmailComposerOptions_attachment.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | attachment
5 | An array of filepaths to files that will be attached to this email.
6 |
7 |
8 | Synopsis:
9 |
{String[]}
10 |
attachment = []
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_EmailComposerOptions_body.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | body
5 | The email body that should be set when the composer is invoked.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
body = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_EmailComposerOptions_calendarevent.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | calendarevent
5 | The calendar event ID to attach to this email.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FILEPICKER_VIEWER_MODE_DEFAULT.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILEPICKER_VIEWER_MODE_DEFAULT
5 | Describes the default view for the viewer of the FilePicker.
6 |
7 |
8 | Synopsis:
9 |
constant {String}
10 |
FILEPICKER_VIEWER_MODE_DEFAULT : "Default"
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FILEPICKER_VIEWER_MODE_GRID.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILEPICKER_VIEWER_MODE_GRID
5 | Describes the grid view for the viewer of the FilePicker.
6 |
7 |
8 | Synopsis:
9 |
constant {String}
10 |
FILEPICKER_VIEWER_MODE_GRID : "GridView"
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FILEPICKER_VIEWER_MODE_LIST.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FILEPICKER_VIEWER_MODE_LIST
5 | Describes the list view for the viewer of the FilePicker.
6 |
7 |
8 | Synopsis:
9 |
constant {String}
10 |
FILEPICKER_VIEWER_MODE_LIST : "ListView"
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | FilePickerOptions
5 | The FilePickerOptions object contains options that are passed into {@link blackberry.invoke.card.invokeFilePicker}(). {Sample - Set Wallpaper using File Picker } https://github.com/blackberry/BB10-WebWorks-Samples/tree/master/SetWallpaper Sample that demonstrates how to use the BlackBerry Invoke FilePicker API [BlackBerry on GitHub].
6 |
7 |
8 | Synopsis:
9 |
FilePickerOptions = {}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_allowOverwrite.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | allowOverwrite
5 | A true or false that describes whether the file being saved can be overwritten or not. Defaults to false. It is only valid in FILEPICKER_MODE_SAVER and FILEPICKER_MODE_SAVER_MULTIPLE.
6 |
7 |
8 | Synopsis:
9 |
{Boolean}
10 |
allowOverwrite = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_defaultType.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | defaultType
5 | A string that describes the default type selected in the FilePicker dropdown. Defaults to the first type in the array of option.type. Only takes affect if more than one options.type is selected. Availabe types can be found under properties.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
defaultType = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_directory.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | directory
5 | An array of strings where only the first value in array describes the folder that will presented to the FilePicker, all other items will be ignored. Defaults to the last folder that the picker was opened in. Recommended to be specified with every call to control the user experience.
6 |
7 |
8 | Synopsis:
9 |
{String[]}
10 |
directory = []
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_filter.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | filter
5 | An array of strings that the file picker files should be filtered on. example [".jpg",".bmp"]. Defaults to no filter.
6 |
7 |
8 | Synopsis:
9 |
{String[]}
10 |
filter = []
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_imageCrop.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | imageCrop
5 | A true or false to describe the imageCrop. Defaults to false. It will only be allowed for pictures of format jpg, jpe, jpeg or png in mode FILEPICKER_MODE_PICKER and FILEPICKER_MODE_PICKER_MULTIPLE.
6 |
7 |
8 | Synopsis:
9 |
{Boolean}
10 |
imageCrop = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_mode.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | mode
5 | A string that describes the mode of the FilePicker. Availabe modes can be found under properties.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
mode = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_sortBy.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | sortBy
5 | A string describes the FilePicker's sort by name or date or suffix or size. Availabe sort by fields can be found under properties.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
sortBy = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_sortOrder.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | sortOrder
5 | A string describes the viewer sort order of the FilePicker, such as ascending or descending or default layout. Defaults to default sort order. Availabe modes can be found under properties.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
sortOrder = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_title.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | title
5 | A string that describes the title of the FilePicker. Defaults to the folder name.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
title = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_type.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | type
5 | An array of strings that describes the type of files that the FilePicker will show. Defaults to showing all types. Availabe types can be found under properties.
6 |
7 |
8 | Synopsis:
9 |
{String[]}
10 |
type = []
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_FilePickerOptions_viewMode.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | viewMode
5 | A string describes the viewer mode of the FilePicker, such as grid or list layout. Availabe view modes can be found under properties.
6 |
7 |
8 | Synopsis:
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_MediaPlayerOptions_contentTitle.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | contentTitle
5 | The title to be displayed in the media player title field.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
contentTitle = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_MediaPlayerOptions_contentUri.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | contentUri
5 | The URL for the content to be played.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
contentUri = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoke_card_MediaPlayerOptions_imageUri.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | imageUri
5 | The image source URL that will be used to replace the default background image. This is useful if the content is audio type.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
imageUri = ""
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_invoked.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Invoked
5 | The Invoked object allows the application to be invoked by other applications.
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/api/blackberry_io_SDCard.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | SDCard
5 | The full file path for the SD card folder
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_io_filetransfer.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | filetransfer
5 | The FileTransfer object contains functions for uploading and downloading files to/from a remote server.
6 |
7 |
8 | Sample that demonstrates how to use the BlackBerry File Transfer API [BlackBerry on GitHub].
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/api/blackberry_io_filetransfer_CONNECTION_ERR.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CONNECTION_ERR
5 | The upload failed due to a connection error.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_io_filetransfer_INVALID_URL_ERR.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | INVALID_URL_ERR
5 | The URL of the server was invalid.
6 |
7 |
8 | Synopsis:
9 |
constant {Number}
10 |
INVALID_URL_ERR : 2
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_io_filetransfer_PERMISSIONS_ERR.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | PERMISSIONS_ERR
5 | Application unable to write to target folder due to insufficient permissions.
6 |
7 |
8 | Synopsis:
9 |
constant {Number}
10 |
PERMISSIONS_ERR : 4
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_io_home.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | home
5 | The full file path for the application data folder
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_io_sandbox.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | sandbox
5 | Whether the file system is sandboxed. It is set to true by default When sandbox is set to false, you must use absolute path to reference a file or directory, you can use sharedFolder, home or SDCard to construct file paths..
6 |
7 |
8 | Synopsis:
9 |
sandbox : true {Boolean}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_io_sharedFolder.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | sharedFolder
5 | The full file path for the shared folder
6 |
7 |
8 | Synopsis:
9 |
<permission access_pimdomain_contacts Permits your app to access contacts.>
9 |
10 |
11 |
12 | Sample that demonstrates how to use the BlackBerry Contacts API [BlackBerry Community Samples on GitHub].
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_Contact.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Contact
5 | The Contact object represents a contact in the device PIM. It can be obtained by calling blackberry.pim.contacts.create() or blackberry.pim.contacts.find().
6 |
7 |
8 | Sample that demonstrates how to use the BlackBerry Contacts API [BlackBerry Community Samples on GitHub].
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactAccount.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | ContactAccount
5 | The ContactAccount object contains information of a contact account.
6 |
7 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactAccount_enterprise.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | enterprise
5 | True when this contact account is an enterprise account.
6 |
7 |
8 | Synopsis:
9 |
read-only {Boolean}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactAccount_id.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | id
5 | Contains the id of this contact account.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactAccount_name.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | name
5 | Name of the contact account.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactActivity.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | ContactActivity
5 | The ContactActivity object is an activity that is linked to the contact by either an email, phone call, or calendar event.
6 |
7 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactActivity_INCOMING.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | INCOMING
5 | The direction of the activity is incoming.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactActivity_description.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | description
5 | This is the description of the activity. For messages, this would be the subject. For call log, this would be the phone number.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactActivity_direction.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | direction
5 | If True, the direction of the activity is incoming, and outgoing otherwise.
6 |
7 |
8 | Synopsis:
9 |
read-only {Boolean}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactActivity_mimeType.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | mimeType
5 | The MIME Type value of the operation in question.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_DIRECT.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | DIRECT
5 | The type of ContactField is "mobile". This constant can be used for fax numbers.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_HOME.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | HOME
5 | The type of ContactField is "home". This constant can be used for email addresses, phone numbers, fax numbers, and pager numbers.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_MOBILE.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | MOBILE
5 | The type of ContactField is "mobile". This constant can be used for phone numbers.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_OTHER.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | OTHER
5 | The type of ContactField is "other". This constant can be used for email addresses, phone numbers, fax numbers, and pager numbers.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_WORK.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | WORK
5 | The type of ContactField is "work". This constant can be used for email addresses, phone numbers, fax numbers, and pager numbers.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_type.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | type
5 | Specifies the type of ContactField.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactField_value.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | value
5 | The value of the field. For example, an email address or a phone number.
6 |
7 |
8 | Synopsis:
9 |
{String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactFindOptions.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | ContactFindOptions
5 | The ContactFindOptions object contains fields that filter and sort the results of ().
6 |
7 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactFindOptions_SEARCH_FIELD_BBMPIN.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | SEARCH_FIELD_BBMPIN
5 | Used by specifying the search filter
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactFindOptions_excludeAccounts.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | excludeAccounts
5 | If specified, search results will be filtered to contain only contacts where the sources of the contact do not come from any of the provided accounts. If an empty array is passed, this property will be ignored. If a non-array is passed, the error callback will be triggered.
6 |
7 |
8 | Synopsis:
9 |
{blackberry.pim.contacts.ContactAccount[]}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactFindOptions_favourite.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | favorite
5 | If set to true, only Contacts marked as favorite would be included in search results.
6 |
7 |
8 | Synopsis:
9 |
An array of object literals that specifies search criteria to filter the results.
6 |
The object should be in the following form:
7 |
8 | {
9 | fieldName: <The field being searched, one of the SORT_FIELD_* constants>,
10 | fieldValue: <value of the field>
11 | }
12 |
13 |
14 |
15 | Synopsis:
16 |
{Object[]}
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactFindOptions_includeAccounts.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | includeAccounts
5 | If specified, search results will be filtered to contain only contacts where the sources of the contact come from any of the provided accounts. If an empty array is passed, this property will be ignored. If a non-array is passed, the error callback will be triggered.
6 |
7 |
8 | Synopsis:
9 |
{blackberry.pim.contacts.ContactAccount[]}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_ContactFindOptions_limit.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | limit
5 | The maximum number of contact results returned. If limit is set to -1, all matching contacts will be returned.
6 |
7 |
8 | Synopsis:
9 |
An array of object literals that specifies the order of the results.
6 |
The object should be in the following form:
7 |
8 | {
9 | fieldName: <The field being searched, one of the SORT_FIELD_* constants>,
10 | desc: true to sort results in descending order (descending if true).
11 | }
12 |
This mode allows the selection of multiple contacts.
The user can select multiple contacts and the selection completes when the user confirms the selection using the confirmation button.
6 |
7 |
8 | Synopsis:
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_Contact_categories.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | categories
5 | An array of all the contacts user defined categories.
6 |
7 |
8 | Synopsis:
9 |
{blackberry.pim.contacts.ContactField[]}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_Contact_clone.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | clone()
5 | Returns a new Contact object that is a deep copy of the calling object, with the id property set to null.
6 |
7 |
8 | Synopsis:
9 |
clone()
10 |
11 |
12 | Returns:
13 |
14 |
15 |
{blackberry.pim.contacts.Contact}
16 |
17 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/api/blackberry_pim_contacts_Contact_displayName.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | displayName
5 | The name of this Contact, suitable for display to end-users.
6 |
7 |
8 | Synopsis:
9 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushPayLoad_id.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | id
5 | The ID of a push.
6 |
7 |
8 | Synopsis:
9 |
readOnly {String}
10 |
id = undefined
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushPayLoad_isAcknowledgeRequired.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | isAcknowledgeRequired
5 | Indicates whether or not a developer must acknowledge the receipt of a push. True if an acknowledgement is required for the push; false otherwise.
6 |
7 |
8 | Synopsis:
9 |
readOnly {Boolean}
10 |
isAcknowledgeRequired = undefined
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_CREATE_CHANNEL_NOT_DONE.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CREATE_CHANNEL_NOT_DONE
5 | Result error code when attempting to perform a destroy channel and a create channel has not been done beforehand. Operations this error can occur on: destroyChannel. Recommended action: This might mean a programming error in the application.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
CREATE_CHANNEL_NOT_DONE : 10106
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_CREATE_CHANNEL_OPERATION.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CREATE_CHANNEL_OPERATION
5 | Constant associated with the createChannel operation. Compare this constant against pushTransportReadyCallback.lastFailedOperation to determine which failed operation should be tried again.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
CREATE_CHANNEL_OPERATION : 1
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_CREATE_SESSION_NOT_DONE.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | CREATE_SESSION_NOT_DONE
5 | Result error code when attempting to perform an operation and a create session has not been done beforehand. Operations this error can occur on: createChannel, destroyChannel, launchApplicationOnPush. Recommended action: This usually means a programming error in the application.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
CREATE_SESSION_NOT_DONE : 10100
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_DESTROY_CHANNEL_OPERATION.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | DESTROY_CHANNEL_OPERATION
5 | Constant associated with the destroyChannel operation. Compare this constant against pushTransportReadyCallback.lastFailedOperation to determine which failed operation should be tried again.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
DESTROY_CHANNEL_OPERATION : 2
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_INTERNAL_ERROR.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | INTERNAL_ERROR
5 | Result error code for an internal error. Operations this error can occur on: create, createChannel, destroyChannel, launchApplicationOnPush. Recommended action: Retrying the operation might correct the issue.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
INTERNAL_ERROR : 500
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_INVALID_PPG_URL.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | INVALID_PPG_URL
5 | Result error code when an invalid PPG URL was specified. Operations this error can occur on: createChannel, destroyChannel (only if using public/BIS PPG). Recommended action: Specifying a valid value for options.ppgUrl in the static create function and retrying might correct the issue.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
INVALID_PPG_URL : 10114
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_MISSING_INVOKE_TARGET_ID.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | MISSING_INVOKE_TARGET_ID
5 | Result error code when no invoke target ID is specified on a create operation. Operations this error can occur on: create. Recommended action: Specifying a value for options.invokeTargetId in the static create function and retrying might correct the issue.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
MISSING_INVOKE_TARGET_ID : 10111
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_MISSING_PORT_FROM_PPG.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | MISSING_PORT_FROM_PPG
5 | Result error code as a result of an issue on a create channel operation obtaining a port from the PPG. Operations this error can occur on: createChannel. Recommended action: Retrying the operation might correct the issue.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
MISSING_PORT_FROM_PPG : 10107
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_MISSING_PPG_URL.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | MISSING_PPG_URL
5 | Result error code when attempting to perform a create channel and a PPG URL was missing. Operations this error can occur on: createChannel (only if using public/BIS PPG). Recommended action: Specifying a value for options.ppgUrl in the static create function and retrying might correct the issue.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
MISSING_PPG_URL : 10102
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_OPERATION_NOT_SUPPORTED.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | OPERATION_NOT_SUPPORTED
5 | Result error code when a certain operation is currently not supported. Recommended action: This operation might not yet be implemented and so should not be performed.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
OPERATION_NOT_SUPPORTED : 10105
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_PPG_SERVER_ERROR.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | PPG_SERVER_ERROR
5 | Result error code when the PPG returns a server error. Operations this error can occur on: createChannel, destroyChannel (only if using public/BIS PPG). Recommended action: Wait until pushTransportReadyCallback (one of the arguments in the static create function) is called before retrying.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
PPG_SERVER_ERROR : 10110
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_SESSION_ALREADY_EXISTS.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | SESSION_ALREADY_EXISTS
5 | Result error code when an underlying session already exists. Operations this error can occur on: create. Recommended action: Check options.appId and options.invokeTargetId in the static create function to ensure that they are valid and unique to your application.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
SESSION_ALREADY_EXISTS : 10112
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_push_PushService_SUCCESS.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | SUCCESS
5 | Result code for an operation that was performed successfully. Operations this code applies to: create, createChannel, destroyChannel, launchApplicationOnPush.
6 |
7 |
8 | Synopsis:
9 |
constant, static {Number}
10 |
SUCCESS : 0
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_sensors_supportedSensors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | supportedSensors
5 | Returns an array of the supported sensors on the current device.
6 |
7 |
8 | Supported Platform(s):
9 |
BlackBerry 10
10 |
11 |
12 | Synopsis:
13 |
read-only {String[]}
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/api/blackberry_system_ALLOW.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | ALLOW
5 | Returned by hasPermission() indicating that the module requested is accessible.
6 |
7 |
8 | Synopsis:
9 |
constant {Number}
10 |
ALLOW : 0
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_system_DENY.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | DENY
5 | Returned by hasPermission() indicating that the module is not accessible.
6 |
7 |
8 | Synopsis:
9 |
constant {Number}
10 |
DENY : 1
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_system_deviceLockedStatus.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | deviceLockedStatus
5 | Returns the locked state of the device. The possible states are: passwordLocked, notLocked, or screenLocked.
6 |
7 |
8 | Synopsis:
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_system_language.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | language
5 | Returns the current UI language for the device. Examples of
6 | possible values include, but are not limited to "fr_CA", "en_CA",
7 | "en_US", and "es_ES". The format of the response conforms to
8 | BCP47.
9 |
10 |
11 |
12 | Synopsis:
13 |
read-only {String}
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/api/blackberry_system_name.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | name
5 | Returns the name of the device.
6 |
7 |
8 | Synopsis:
9 |
read-only {String}
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/api/blackberry_system_region.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | region
5 | Returns the current country setting for the device. The
6 | region determines the format of items such as the date, time, numbers,
7 | and the calendar. Examples of possible values include, but are not
8 | limited to "fr_CA", "en_CA", "en_US", and "es_ES". The format of the
9 | response conforms to BCP47.
10 |
11 |
12 |
13 | Synopsis:
14 |
read-only {String}
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/api/blackberry_system_setWallpaper.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | setWallpaper()
5 | Set the wallpaper using the path to the file provided.
6 |
7 |
8 | Synopsis:
9 |
setWallpaper()
10 |
11 |
12 | Parameters:
13 |
14 |
15 |
filepath {String}
16 |
Path to the file to be used as wallpaper.
17 |
18 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/api/blackberry_system_softwareVersion.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | softwareVersion
5 | Returns the current version of the operating system, for example, 1.0.0.0.
6 |
7 |
8 | Synopsis:
9 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/api/blackberry_ui_cover.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Window Covers
5 | The cover namespace provides the ability to modify the application's window cover which is displayed when the application is in thumbnail mode.
6 |
7 |
https://github.com/blackberry/BB10-WebWorks-Samples/tree/master/WindowCovers Sample that demonstrates how to use the BlackBerry Window Covers API [BlackBerry on GitHub].
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/api/blackberry_ui_cover_CoverLabel.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Cover Labels
5 | Represents a label object to be displayed on the application's window cover.
6 |
7 |
{Sample - Using a label on a Window Cover} https://github.com/blackberry/BB10-WebWorks-Samples/tree/master/WindowCovers Sample that demonstrates how to use the BlackBerry CoverLabel API [BlackBerry on GitHub].
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/api/blackberry_ui_cover_CoverLabel_label.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | label
5 | Text to be displayed for this label
6 |
7 |
8 | Synopsis:
9 |
The functionality in this object allows you to integrate standard system dialog boxes into your BlackBerry WebWorks Application and control your application flow based on user responses.