Mobile/Push/Message/Gcm.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_Gcm
Package: Zend_Mobile\Zend_Mobile_Push
Gcm 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 $_data = array()Data key value pairs
Default value
array()Details- Type
- array
boolean $_delay = falseDelay while idle
Default value
falseDetails- Type
- boolean
array $_token = array()Tokens
Default value
array()Details- Type
- array
int $_ttl = 2419200Time to live in seconds
Default value
2419200Details- Type
- int
Methods
addData(string $key, string $value) : \Zend_Mobile_Push_Message_GcmAdd Data
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | string |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
addToken(string $token) : \Zend_Mobile_Push_Message_GcmAdd a Token
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $token | string |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
clearData() : \Zend_Mobile_Push_Message_GcmClear Data
Returns
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
clearToken() : \Zend_Mobile_Push_Message_GcmClear Tokens
Returns
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
getData() : arrayGet Data
Returns
| Type | Description |
|---|---|
| array |
getDelayWhileIdle() : booleanGet Delay While Idle
Returns
| Type | Description |
|---|---|
| boolean |
getToken() : voidReturns
Details
| Type | Description |
|---|---|
| void |
- Magic
- Method
getTtl() : intGet time to live
Returns
| Type | Description |
|---|---|
| int |
setData(array $data) : \Zend_Mobile_Push_Message_GcmSet Data
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
setDelayWhileIdle(boolean $delay) : \Zend_Mobile_Push_Message_GcmSet Delay While Idle
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $delay | boolean |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
setToken(string | array $token) : \Zend_Mobile_Push_Message_GcmSet Token
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $token | string | array |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
| Exception | Description |
|---|---|
| \Zend_Mobile_Push_Message_Exception |
setTtl(int $secs) : \Zend_Mobile_Push_Message_GcmSet time to live.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $secs | int |
| Type | Description |
|---|---|
| \Zend_Mobile_Push_Message_Gcm |
toJson() : stringTo Json utility method Takes the data and properly assigns it to a json encoded array to match the Gcm format.
Returns
| Type | Description |
|---|---|
| string |
validate() : booleanValidate this is a proper Gcm message Does not validate size.
Returns
| Type | Description |
|---|---|
| boolean |