Zend Framework API Documentation
Back to top  

Apns 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
version $Id$
inherited_from \Zend_Mobile_Push_Message_Abstract

 Methods

Add Custom Data

addCustomData(string $key, mixed $value) : \Zend_Mobile_Push_Message_Apns

Parameters

$key

string

$value

mixed

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Apns

Clear Custom Data

clearCustomData() : \throw

Returns

\thrownew Zend_Mobile_Push_Message_Apns

Get Alert

getAlert() : array

Returns

array

Get Badge

getBadge() : integer

Returns

integer

Get Custom Data

getCustomData() : array

Returns

array

Get Expire

getExpire() : integer

Returns

integer

Get Message ID

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

Returns

integerstringfloatbooleanScalar

Get Sound

getSound() : string

Returns

string

Get Token

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

Returns

string

Set Alert

setAlert(string $text, string|null $actionLocKey = null, string|null $locKey = null, array|null $locArgs = null, string|null $launchImage = null) : \Zend_Mobile_Push_Message_Apns

Parameters

$text

string

$actionLocKey

stringnull

$locKey

stringnull

$locArgs

arraynull

$launchImage

stringnull

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Apns

Set Badge

setBadge(integer $badge) : \Zend_Mobile_Push_Message_Apns

Parameters

$badge

integer

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Apns

Set Custom Data

setCustomData(array $array) : \Zend_Mobile_Push_Message_Apns

Parameters

$array

array

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Apns

Set Expire

setExpire(integer $expire) : \Zend_Mobile_Push_Message_Apns

Parameters

$expire

integer

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Apns

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 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 Sound

setSound(string $sound) : \Zend_Mobile_Push_Message_Apns

Parameters

$sound

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Apns

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 this is a proper Apns message

validate() : boolean
inherited_from \Zend_Mobile_Push_Message_Abstract::validate()

Returns

boolean

Validate Message format

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

Returns

boolean

 Properties

 

Alert

$_alert : array

Default

array()
 

Badge Number

$_badge : integer

Default

 

Custom Data

$_custom : array

Default

array()
 

Expiration

$_expire : integer

Default

 

Id

$_id : integer | string | float | boolean

Default

 

Sound

$_sound : string

Default

'default'
 

Token

$_token : string

Default