Phone
The Phone Identity object contains information regarding the user's phone lines on a BlackBerry smartphone.
Code Example:
|
Supported Platform(s)
- BlackBerry OS 5.0+ |
- Ripple Emulator |
API | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
---|---|---|---|---|---|---|---|
blackberry.identity.phone.getLineIds | Y | Y | Y | Y | |||
blackberry.identity.phone.getLineLabel | Y | Y | Y | Y | |||
blackberry.identity.phone.getLineNumber | Y | Y | Y | Y | |||
blackberry.identity.phone.getLineType | Y | Y | Y | Y |
Configuration Document Settings
To use all of the API described for this object, you must ensure the following settings are in your configuration document: |
You must declare the feature element(s) below in your configuration document: |
Feature ID | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
---|---|---|---|---|---|---|---|
<feature id="blackberry.identity.phone" /> | Y | Y | Y | Y |
Permission Elements (PlayBook and BlackBerry 10+) |
---|
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
Functions
Functions
static
Number[]
blackberry.identity.phone.getLineIds
()
Returns the id of all the lines registered with the device.
Supported Platforms | |
---|---|
- BlackBerry OS 5.0+ | |
- Ripple Emulator |
static
String
blackberry.identity.phone.getLineLabel
(lineId : Number)
Returns a string description of the line specified.
Supported Platforms | |
---|---|
- BlackBerry OS 5.0+ | |
- Ripple Emulator |
Parameters | |
---|---|
lineId | [optional] ID of the line to retrieve the label for. If not specified the label for the default line is returned. |
static
Number
blackberry.identity.phone.getLineNumber
(lineId : Number)
Returns the phone number of the line specified.
Supported Platforms | |
---|---|
- BlackBerry OS 5.0+ | |
- Ripple Emulator |
Parameters | |
---|---|
lineId | [optional] ID of the line to retrieve the label for. If not specified the label for the default line is returned. |
static
Number
blackberry.identity.phone.getLineType
(lineId : Number)
Returns the type of the line specified.
Supported Platforms | |
---|---|
- BlackBerry OS 5.0+ | |
- Ripple Emulator |
Parameters | |
---|---|
lineId | [optional] ID of the line to retrieve the label for. If not specified the label for the default line is returned. |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:41 GMT-0500 (EST)