Mobile/Push/Message/Apns.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2011 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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id$  

Properties

>VPropertyprotectedarray $_alert = array()
Alert
Default valuearray()Details
Type
array
>VPropertyprotectedint $_badge
Badge Number
Details
Type
int
>VPropertyprotectedarray $_custom = array()
Custom Data
Default valuearray()Details
Type
array
>VPropertyprotectedint $_expire
Expiration
Details
Type
int
>VPropertyprotected\scalar $_id
Details
Type
\scalar
Inherited_from
\Zend_Mobile_Push_Message_Abstract::$$_id  
>VPropertyprotectedstring $_sound = 'default'
Sound
Default value'default'Details
Type
string
>VPropertyprotectedstring $_token
inherited
Token
Inherited from: \Zend_Mobile_Push_Message_Abstract::$$_token
Details
Type
string
Inherited_from
\Zend_Mobile_Push_Message_Abstract::$$_token  

Methods

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

Add Custom Data

Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Mobile_Push_Message_Apns
Throws
ExceptionDescription
\Zend_Mobile_Push_Message_Exception
methodpublicclearCustomData() : \throw

Clear Custom Data

Returns
TypeDescription
\thrownew Zend_Mobile_Push_Message_Apns
methodpublicgetAlert() : array

Get Alert

Returns
TypeDescription
array
methodpublicgetBadge() : int

Get Badge

Returns
TypeDescription
int
methodpublicgetCustomData() : array

Get Custom Data

Returns
TypeDescription
array
methodpublicgetExpire() : int

Get Expire

Returns
TypeDescription
int
methodpublicgetId() : \scalar
inherited

Get Message ID

Inherited from: \Zend_Mobile_Push_Message_Abstract::getId()
Returns
TypeDescription
\scalar
methodpublicgetSound() : string

Get Sound

Returns
TypeDescription
string
methodpublicgetToken() : string
inherited

Get Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::getToken()
Returns
TypeDescription
string
methodpublicsetAlert(string $text, string $actionLocKey = null, string $locKey = null, array $locArgs = null, string $launchImage = null) : \Zend_Mobile_Push_Message_Apns

Set Alert

Parameters
NameTypeDescription
$textstring
$actionLocKeystring
$locKeystring
$locArgsarray
$launchImagestring
Returns
TypeDescription
\Zend_Mobile_Push_Message_Apns
methodpublicsetBadge(int $badge) : \Zend_Mobile_Push_Message_Apns

Set Badge

Parameters
NameTypeDescription
$badgeint
Returns
TypeDescription
\Zend_Mobile_Push_Message_Apns
Throws
ExceptionDescription
\Zend_Mobile_Push_Message_Exception
methodpublicsetCustomData( $array) : \Zend_Mobile_Push_Message_Apns

Set Custom Data

Parameters
NameTypeDescription
$array
Returns
TypeDescription
\Zend_Mobile_Push_Message_Apns
Throws
ExceptionDescription
\Zend_Mobile_Push_Message_Exception
methodpublicsetExpire(int $expire) : \Zend_Mobile_Push_Message_Apns

Set Expire

Parameters
NameTypeDescription
$expireint
Returns
TypeDescription
\Zend_Mobile_Push_Message_Apns
Throws
ExceptionDescription
\Zend_Mobile_Push_Message_Exception
methodpublicsetId(\scalar $id) : \Zend_Mobile_Push_Message_Abstract
inherited

Set Message ID

Inherited from: \Zend_Mobile_Push_Message_Abstract::setId()
Parameters
NameTypeDescription
$id\scalar
Returns
TypeDescription
\Zend_Mobile_Push_Message_Abstract
Throws
ExceptionDescription
\Exception
methodpublicsetOptions(array $options) : \Zend_Mobile_Push_Message_Abstract
inherited

Set Options

Inherited from: \Zend_Mobile_Push_Message_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Mobile_Push_Message_Abstract
Throws
ExceptionDescription
\Zend_Mobile_Push_Message_Exception
methodpublicsetSound(string $sound) : \Zend_Mobile_Push_Message_Apns

Set Sound

Parameters
NameTypeDescription
$soundstring
Returns
TypeDescription
\Zend_Mobile_Push_Message_Apns
Throws
ExceptionDescription
\Zend_Mobile_Push_Message_Exception
methodpublicsetToken(string $token) : \Zend_Mobile_Push_Message_Abstract
inherited

Set Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::setToken()
Parameters
NameTypeDescription
$tokenstring
Returns
TypeDescription
\Zend_Mobile_Push_Message_Abstract
methodpublicvalidate() : boolean

Validate this is a proper Apns message

Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.