Mobile/Push/Message/Mpns.php

Show: inherited
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 [email protected] 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  

\Zend_Mobile_Push_Message_Mpns

Package: Zend\Mobile\Zend\Mobile\Push

Mpns Message

Parent(s)
\Zend_Mobile_Push_Message_Abstract
Children
\Zend_Mobile_Push_Message_Mpns_Toast
\Zend_Mobile_Push_Message_Mpns_Tile
\Zend_Mobile_Push_Message_Mpns_Raw
Category
Zend  
Copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id$  

Constants

Constantstring  TYPE_RAW = 'raw'

Mpns types

string
Constant  TYPE_TILE = 'token'
Constant  TYPE_TOAST = 'toast'

Properties

Propertyprotectedint $_delay =

Delay

Details
Type
int
Propertyprotected\scalar $_id =
inherited

Id

Inherited from: \Zend_Mobile_Push_Message_Abstract::$$_id
Details
Type
\scalar
Inherited_from
\Zend_Mobile_Push_Message_Abstract::$$_id  
Propertyprotectedstring $_token =
inherited

Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::$$_token
Details
Type
string
Inherited_from
\Zend_Mobile_Push_Message_Abstract::$$_token  

Methods

methodpublicgetDelay() : int
abstract

Get Delay

Returns
Type Description
int
methodpublicgetId() : \scalar
inherited

Get Message ID

Inherited from: \Zend_Mobile_Push_Message_Abstract::getId()
Returns
Type Description
\scalar
methodpublicgetNotificationType() : string
static

Get Notification Type

Returns
Type Description
string
methodpublicgetToken() : string
inherited

Get Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::getToken()
Returns
Type Description
string
methodpublicgetXmlPayload() : string
abstract

Get XML Payload

Returns
Type Description
string
methodpublicsetDelay(int $delay) : \Zend_Mobile_Push_Message_Mpns
abstract

Set Delay

Parameters
Name Type Description
$delay int

one of const DELAY_* of implementing classes

Returns
Type Description
\Zend_Mobile_Push_Message_Mpns
methodpublicsetId(\scalar $id) : \Zend_Mobile_Push_Message_Abstract
inherited

Set Message ID

Inherited from: \Zend_Mobile_Push_Message_Abstract::setId()
Parameters
Name Type Description
$id \scalar
Returns
Type Description
\Zend_Mobile_Push_Message_Abstract
Throws
Exception Description
\Exception
methodpublicsetOptions(array $options) : \Zend_Mobile_Push_Message_Abstract
inherited

Set Options

Inherited from: \Zend_Mobile_Push_Message_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Mobile_Push_Message_Abstract
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicsetToken(string $token) : \Zend_Mobile_Push_Message_Mpns

Set Token

Parameters
Name Type Description
$token string
Returns
Type Description
\Zend_Mobile_Push_Message_Mpns
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicvalidate() : boolean

Validate proper mpns message

Returns
Type Description
boolean
Documentation was generated by phpDocumentor 2.0.0a8.