Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Mobile_Push_Message_Gcm Class Reference

Public Member Functions

 addToken ($token)
 Add a Token.
 
 setToken ($token)
 Set Token.
 
 clearToken ()
 Clear Tokens.
 
 addData ($key, $value)
 Add Data.
 
 setData (array $data)
 Set Data.
 
 clearData ()
 Clear Data.
 
 getData ()
 Get Data.
 
 setDelayWhileIdle ($delay)
 Set Delay While Idle.
 
 getDelayWhileIdle ()
 Get Delay While Idle.
 
 setTtl ($secs)
 Set time to live.
 
 getTtl ()
 Get time to live.
 
 validate ()
 Validate this is a proper Gcm message Does not validate size.
 
 toJson ()
 To Json utility method Takes the data and properly assigns it to a json encoded array to match the Gcm format.
 
- Public Member Functions inherited from Zend_Mobile_Push_Message_Abstract
 getToken ()
 Get Token.
 
 setToken ($token)
 Set Token.
 
 getId ()
 Get Message ID.
 
 setId ($id)
 Set Message ID.
 
 setOptions (array $options)
 Set Options.
 
 validate ()
 Validate Message format.
 

Protected Attributes

 $_token = array()
 
 $_data = array()
 
 $_delay = false
 
 $_ttl = 2419200
 
- Protected Attributes inherited from Zend_Mobile_Push_Message_Abstract
 $_token
 
 $_id
 

Member Function Documentation

addData (   $key,
  $value 
)

Add Data.

Parameters
string$key
string$value
Returns
Zend_Mobile_Push_Message_Gcm
Exceptions
Zend_Mobile_Push_Message_Exception
addToken (   $token)

Add a Token.

Parameters
string$token
Returns
Zend_Mobile_Push_Message_Gcm
Exceptions
Zend_Mobile_Push_Message_Exception
clearData ( )

Clear Data.

Returns
Zend_Mobile_Push_Message_Gcm
clearToken ( )

Clear Tokens.

Returns
Zend_Mobile_Push_Message_Gcm
getData ( )

Get Data.

Returns
array
getDelayWhileIdle ( )

Get Delay While Idle.

Returns
boolean
getTtl ( )

Get time to live.

Returns
int
setData ( array  $data)

Set Data.

Parameters
array$data
Returns
Zend_Mobile_Push_Message_Gcm
Exceptions
Zend_Mobile_Push_Message_Exception
setDelayWhileIdle (   $delay)

Set Delay While Idle.

Parameters
boolean$delay
Returns
Zend_Mobile_Push_Message_Gcm
Exceptions
Zend_Mobile_Push_Message_Exception
setToken (   $token)

Set Token.

Parameters
string | array$token
Returns
Zend_Mobile_Push_Message_Gcm
Exceptions
Zend_Mobile_Push_Message_Exception

Implements Zend_Mobile_Push_Message_Interface.

setTtl (   $secs)

Set time to live.

Parameters
int$secs
Returns
Zend_Mobile_Push_Message_Gcm
toJson ( )

To Json utility method Takes the data and properly assigns it to a json encoded array to match the Gcm format.

Returns
string
validate ( )

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

Returns
boolean

Implements Zend_Mobile_Push_Message_Interface.

Member Data Documentation

$_data = array()
protected
$_delay = false
protected
$_token = array()
protected
$_ttl = 2419200
protected