Data
The Push Data object provides access to the data that has arrived as the result of a push.
Supported Platform(s)
| - BlackBerry OS 5.0+ |
| - Ripple Emulator |
| API | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|---|---|---|---|---|---|---|
| blackberry.push.Data.getHeaderField | Y | Y | Y | Y | |||
| blackberry.push.Data.getRequestURI | Y | Y | Y | Y | |||
| blackberry.push.Data.getSource | Y | Y | Y | Y | |||
| isChannelEncrypted | Y | Y | Y | Y | |||
| payload | 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.push" /> | 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
static
String
blackberry.push.Data.getHeaderField
(field : Object)
Requests the value of a specified header field. This method expires and will throw an exception if called outside of the push callback function.
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |
| - Ripple Emulator | |
| Parameters | |
|---|---|
| field | This parameter is either the Integer index or a String name of the header to retrieve. |
Return:
Returns the value of a header field.
static
String
blackberry.push.Data.getRequestURI
()
Request the URI of the push request. This method expires and will throw an exception if called outside of the push callback function.
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |
| - Ripple Emulator | |
Return:
Returns the URI of the push request.
static
String
blackberry.push.Data.getSource
()
Retrieves the source for this push stream. String form of the source of this push; it could be a UID for a connection, IPv4 address, or SMSC. This method expires and will throw an exception if called outside of the push callback function.
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |
| - Ripple Emulator | |
Return:
Returns the source of the push request.