Zend Framework API Documentation
Back to top  

Mpns Raw Message

category Zend
package Zend_Mobile
subpackage Zend_Mobile_Push
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Mobile_Push_Message_Mpns

 Methods

Get Delay

getDelay() : integer
inherited_from \Zend_Mobile_Push_Message_Mpns::getDelay()

Returns

integer

Get Delay

getDelay() : integer
Inherited

Returns

integer

Get Message ID

getId() : integer | string | float | boolean
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::getId()

Returns

integerstringfloatbooleanScalar

Get Message

getMessage() : string

Returns

string

Get Notification Type

getNotificationType() : string
Static
inherited_from \Zend_Mobile_Push_Message_Mpns::getNotificationType()

Returns

string

Get Notification Type

getNotificationType() : string
InheritedStatic

Returns

string

Get Token

getToken() : string
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::getToken()

Returns

string

Get XML Payload

getXmlPayload() : string
inherited_from \Zend_Mobile_Push_Message_Mpns::getXmlPayload()

Returns

string

Get XML Payload

getXmlPayload() : string
Inherited

Returns

string

Set Delay

setDelay(integer $delay) : \Zend_Mobile_Push_Message_Mpns_Raw
inherited_from \Zend_Mobile_Push_Message_Mpns::setDelay()

Parameters

$delay

integer

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Raw

Set Delay

setDelay(integer $delay) : \Zend_Mobile_Push_Message_Mpns
Inherited

Parameters

$delay

integer

one of const DELAY_* of implementing classes

Returns

\Zend_Mobile_Push_Message_Mpns

Set Message ID

setId(integer|string|float|boolean $id) : \Zend_Mobile_Push_Message_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::setId()

Parameters

$id

integerstringfloatboolean

Scalar

Exceptions

\Exception

Returns

\Zend_Mobile_Push_Message_Abstract

Set Message

setMessage(string $msg) : \Zend_Mobile_Push_Message_Mpns_Raw

Parameters

$msg

string

XML string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Raw

Set Options

setOptions(array $options) : \Zend_Mobile_Push_Message_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::setOptions()

Parameters

$options

array

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Abstract

Set Token

setToken(string $token) : \Zend_Mobile_Push_Message_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::setToken()

Parameters

$token

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Abstract

Validate proper mpns message

validate() : boolean
inherited_from \Zend_Mobile_Push_Message_Mpns::validate()

Returns

boolean

Validate Message format

validate() : boolean
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::validate()

Returns

boolean

 Properties

 

Delay

$_delay : integer

Default

 

Id

$_id : integer | string | float | boolean

Default

 

Message

$_msg : string

Default

 

Token

$_token : string

Default

 Constants

 

DELAY_450S

DELAY_450S = 13 
 

DELAY_900S

DELAY_900S = 23 
 

Mpns delays

DELAY_IMMEDIATE = 3 : integer
 

Mpns types

TYPE_RAW = 'raw' : string
 

TYPE_TILE

TYPE_TILE = 'token' 
 

TYPE_TOAST

TYPE_TOAST = 'toast'