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+

- Supported Platform Table: Expand

API	OS 5.0	OS 6.0	OS 7.0
blackberry.push.Data.getHeaderField	Y	Y	Y
blackberry.push.Data.getRequestURI	Y	Y	Y
blackberry.push.Data.getSource	Y	Y	Y
isChannelEncrypted	Y	Y	Y
payload	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:

Feature Elements

You must declare the feature element(s) below in your configuration document:

Feature ID	OS 5.0	OS 6.0	OS 7.0	PlayBook
<feature id="blackberry.push" />	Y	Y	Y

Permission Elements (PlayBook Only)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Functions

Properties

blackberry.push.Data.getHeaderField

static String getHeaderField(field : Object)

Supported Platform(s)

- BlackBerry OS 5.0+

Description

Requests the value of a specified header field. This method expires and will throw an exception if called outside of the push callback function.

Returns

Returns the value of a header field.

Parameter	Type	Description
field	Object	This parameter is either the Integer index or a String name of the header to retrieve.

blackberry.push.Data.getRequestURI

static String getRequestURI()

Supported Platform(s)

- BlackBerry OS 5.0+

Description

Request the URI of the push request. This method expires and will throw an exception if called outside of the push callback function.

Returns

Returns the URI of the push request.

blackberry.push.Data.getSource

static String getSource()

Supported Platform(s)

- BlackBerry OS 5.0+

Description

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.

Returns

Returns the source of the push request.

Properties:

Property	Type	Description	Supported Platform(s)
isChannelEncrypted	Boolean readonly	True if this channel is encrypted; otherwise, false.	- BlackBerry OS 5.0+
payload	Blob readonly	The binary data pushed to the device.	- BlackBerry OS 5.0+

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Sep 14 2011 09:55:31 GMT-0000 (UTC)