net.rim.blackberry.push.PushPayload

PushPayload

Properties | Methods


Packagenet.rim.blackberry.push
Classpublic class PushPayload
InheritancePushPayload Inheritance Object

A push message (complete with its headers and data).

Class information:
BlackBerry 10 Version: 10.0.0
Found in:  BlackBerryPushService.ane

See also

net.rim.blackberry.push.PushService



Public Properties

 PropertyDefined By
  data : ByteArray
[read-only] Gets the data of a push.
PushPayload
  id : String
[read-only] Gets the unique ID of this push message.
PushPayload
  isAckRequired : Boolean
[read-only] Indicates whether or not a developer must acknowledge the receipt of a push.
PushPayload

Public Methods

 MethodDefined By
  
getHeader(headerName:String):String
Gets the header value matching the given header name.
PushPayload
  
getHeaders():Object
Gets the associative array containing header name-value pairs with a string key.
PushPayload

Property Detail

data


data:ByteArray  [read-only]

Gets the data of a push.


Implementation

public function get data():ByteArray

id


id:String  [read-only]

Gets the unique ID of this push message. This ID is required to be passed to the acceptPush or rejectPush APIs of the PushService class if acknowledgement of this push message is required.


Implementation

public function get id():String

isAckRequired


isAckRequired:Boolean  [read-only]

Indicates whether or not a developer must acknowledge the receipt of a push. Acknowledgement is done using the acceptPush or rejectPush APIs of the PushService class.


Implementation

public function get isAckRequired():Boolean

Method Detail

getHeader()


public function getHeader(headerName:String):String

Gets the header value matching the given header name.

Parameters

headerName:String — the header name

Returns

String — the header value

getHeaders()


public function getHeaders():Object

Gets the associative array containing header name-value pairs with a string key.

Example usage: var headers:Object = getHeaders(); var headerValue:String = headers["someHeader"];

Returns

Object — the associative array of headers




comments powered by Disqus