Mobile/Push/Message/Apns.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mobile
- Subpackage
- Zend_Mobile_Push
- Version
- $Id$
\Zend_Mobile_Push_Message_Apns
Package: Zend_Mobile\Zend_Mobile_Push
Apns Message
- Parent(s)
- \Zend_Mobile_Push_Message_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
array $_alert = array()Alert
Default value
array()Details- Type
- array
int $_badgeBadge Number
Details
- Type
- int
array $_custom = array()Custom Data
Default value
array()Details- Type
- array
int $_expireExpiration
Details
- Type
- int
string $_sound = 'default'Sound
Default value
'default'Details- Type
- string
Methods
addCustomData(string $key, mixed $value) : \Zend_Mobile_Push_Message_ApnsAdd Custom Data
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Apns |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
clearCustomData() : \throwClear Custom Data
Returns
| Type | Description |
|---|---|
| \throw | new Zend_Mobile_Push_Message_Apns |
getAlert() : arrayGet Alert
Returns
| Type | Description |
|---|---|
| array |
getBadge() : intGet Badge
Returns
| Type | Description |
|---|---|
| int |
getCustomData() : arrayGet Custom Data
Returns
| Type | Description |
|---|---|
| array |
getExpire() : intGet Expire
Returns
| Type | Description |
|---|---|
| int |
getSound() : stringGet Sound
Returns
| Type | Description |
|---|---|
| string |
setAlert(string $text, string $actionLocKey = null, string $locKey = null, array $locArgs = null, string $launchImage = null) : \Zend_Mobile_Push_Message_ApnsSet Alert
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $text | string | |
| $actionLocKey | string | |
| $locKey | string | |
| $locArgs | array | |
| $launchImage | string |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Apns |
setBadge(int $badge) : \Zend_Mobile_Push_Message_ApnsSet Badge
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $badge | int |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Apns |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
setCustomData( $array) : \Zend_Mobile_Push_Message_ApnsSet Custom Data
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $array |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Apns |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
setExpire(int $expire) : \Zend_Mobile_Push_Message_ApnsSet Expire
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $expire | int |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Apns |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
setSound(string $sound) : \Zend_Mobile_Push_Message_ApnsSet Sound
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $sound | string |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Apns |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
validate() : booleanValidate this is a proper Apns message
Returns
| Type | Description |
|---|---|
| boolean |