Mobile/Push/Message/Mpns/Toast.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_Toast

Package: Zend\Mobile\Zend\Mobile\Push

Mpns Toast Message

Parent(s)
\Zend_Mobile_Push_Message_Mpns < \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$  

Constants

Constantint  DELAY_IMMEDIATE = 2

Mpns delays

int
Constant  DELAY_450S = 12
Constant  DELAY_900S = 22
Constantstring  TYPE_RAW = 'raw'
inherited

Mpns types

Inherited from: \Zend_Mobile_Push_Message_Mpns::TYPE_RAW
Inherited_from
\Zend_Mobile_Push_Message_Mpns::TYPE_RAW  
string
Constant  TYPE_TILE = 'token'
Constant  TYPE_TOAST = 'toast'

Properties

Propertyprotectedint $_delay =
inherited

Delay

Inherited from: \Zend_Mobile_Push_Message_Mpns::$$_delay
Details
Type
int
Inherited_from
\Zend_Mobile_Push_Message_Mpns::$$_delay  
Propertyprotected\scalar $_id =
Details
Type
\scalar
Inherited_from
\Zend_Mobile_Push_Message_Abstract::$$_id  
Inherited_from
\Zend_Mobile_Push_Message_Mpns::$$_id  
Propertyprotectedstring $_msg =

Message

Details
Type
string
Propertyprotectedstring $_params =

Params

Details
Type
string
Propertyprotectedstring $_title =

Title

Details
Type
string

Methods

methodpublicgetDelay() : int

Get Delay

Returns
Type Description
int
methodpublicgetId() : \scalar
Returns
Type Description
\scalar
methodpublicgetMessage() : string

Get Message

Returns
Type Description
string
methodpublicgetNotificationType() : string
static

Get Notification Type

Returns
Type Description
string
methodpublicgetParams() : string

Get Params

Returns
Type Description
string
methodpublicgetTitle() : string

Get Title

Returns
Type Description
string
methodpublicgetToken() : string
Returns
Type Description
string
methodpublicgetXmlPayload() : string

Get XML Payload

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

Set Delay

Parameters
Name Type Description
$delay int
Returns
Type Description
\Zend_Mobile_Push_Message_Mpns_Toast
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicsetId(\scalar $id) : \Zend_Mobile_Push_Message_Abstract
Parameters
Name Type Description
$id \scalar
Returns
Type Description
\Zend_Mobile_Push_Message_Abstract
Throws
Exception Description
\Exception
methodpublicsetMessage(string $msg) : \Zend_Mobile_Push_Message_Mpns_Toast

Set Message

Parameters
Name Type Description
$msg string
Returns
Type Description
\Zend_Mobile_Push_Message_Mpns_Toast
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicsetOptions(array $options) : \Zend_Mobile_Push_Message_Abstract
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Mobile_Push_Message_Abstract
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicsetParams(string $params) : \Zend_Mobile_Push_Message_Mpns_Toast

Set Params

Parameters
Name Type Description
$params string
Returns
Type Description
\Zend_Mobile_Push_Message_Mpns_Toast
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicsetTitle(string $title) : \Zend_Mobile_Push_Message_Mpns_Toast

Set Title

Parameters
Name Type Description
$title string
Returns
Type Description
\Zend_Mobile_Push_Message_Mpns_Toast
Throws
Exception Description
\Zend_Mobile_Push_Message_Exception
methodpublicsetToken(string $token) : \Zend_Mobile_Push_Message_Mpns
inherited

Set Token

Inherited from: \Zend_Mobile_Push_Message_Mpns::setToken()
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.