Mobile/Push/Message/Gcm.php

Show:

inherited

Classes
- \Zend_Mobile_Push_Message_Gcm

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
Version: $Id$

\Zend_Mobile_Push_Message_Gcm
jump to top

Package: Zend\Mobile\Zend\Mobile\Push

Gcm 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

array $_data = array()

Data key value pairs

Default valuearray()Details

Type: array

boolean $_delay = false

Delay while idle

Default valuefalseDetails

Type: boolean

\scalar $_id =

inherited

Inherited from: \Zend_Mobile_Push_Message_Abstract::$$_id

Details

Type: \scalar
Inherited_from: \Zend_Mobile_Push_Message_Abstract::$$_id

array $_token = array()

Tokens

Default valuearray()Details

Type: array

int $_ttl = 0

Time to live in seconds

Default value0Details

Type: int

Methods

addData(string $key, string $value) : \Zend_Mobile_Push_Message_Gcm

Add Data

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

addToken(string $token) : \Zend_Mobile_Push_Message_Gcm

Add a Token

Parameters

Name	Type	Description
$token	string

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

clearData() : \Zend_Mobile_Push_Message_Gcm

Clear Data

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

clearToken() : \Zend_Mobile_Push_Message_Gcm

Clear Tokens

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

getData() : array

Get Data

Returns

Type	Description
array

getDelayWhileIdle() : boolean

Get Delay While Idle

Returns

Type	Description
boolean

getId() : \scalar

inherited

Get Message ID

Inherited from: \Zend_Mobile_Push_Message_Abstract::getId()

Returns

Type	Description
\scalar

getToken() : string

inherited

Get Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::getToken()

Returns

Type	Description
string

getToken() : array

Returns

Type	Description
array

Details

Magic
Method

getTtl() : int

Get time to live

Returns

Type	Description
int

setData(array $data) : \Zend_Mobile_Push_Message_Gcm

Set Data

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

setDelayWhileIdle(boolean $delay) : \Zend_Mobile_Push_Message_Gcm

Set Delay While Idle

Parameters

Name	Type	Description
$delay	boolean

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

setId(\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

setOptions(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

setToken(string | array $token) : \Zend_Mobile_Push_Message_Gcm

Set Token

Parameters

Name	Type	Description
$token	string \| array

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

setTtl(int $secs) : \Zend_Mobile_Push_Message_Gcm

Set time to live If $secs is set to 0 it will be handled as not being set.

Parameters

Name	Type	Description
$secs	int

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

toJson() : string

To 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() : boolean

Validate this is a proper Gcm message Does not validate size.

Returns

Type	Description
boolean

Mobile/Push/Message/Gcm.php

\Zend_Mobile_Push_Message_Gcmjump to top

Properties

Methods

\Zend_Mobile_Push_Message_Gcm
jump to top