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

Public Member Functions

 getAlert ()
 Get Alert.
 
 setAlert ($text, $actionLocKey=null, $locKey=null, $locArgs=null, $launchImage=null)
 Set Alert.
 
 getBadge ()
 Get Badge.
 
 setBadge ($badge)
 Set Badge.
 
 getExpire ()
 Get Expire.
 
 setExpire ($expire)
 Set Expire.
 
 getSound ()
 Get Sound.
 
 setSound ($sound)
 Set Sound.
 
 addCustomData ($key, $value)
 Add Custom Data.
 
 clearCustomData ()
 Clear Custom Data.
 
 setCustomData ($array)
 Set Custom Data.
 
 getCustomData ()
 Get Custom Data.
 
 validate ()
 Validate this is a proper Apns message.
 
- 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

 $_badge
 
 $_alert = array()
 
 $_expire
 
 $_sound = 'default'
 
 $_custom = array()
 
- Protected Attributes inherited from Zend_Mobile_Push_Message_Abstract
 $_token
 
 $_id
 

Member Function Documentation

addCustomData (   $key,
  $value 
)

Add Custom Data.

Parameters
string$key
mixed$value
Returns
Zend_Mobile_Push_Message_Apns
Exceptions
Zend_Mobile_Push_Message_Exception
clearCustomData ( )

Clear Custom Data.

Returns
throw new Zend_Mobile_Push_Message_Apns
getAlert ( )

Get Alert.

Returns
array
getBadge ( )

Get Badge.

Returns
int
getCustomData ( )

Get Custom Data.

Returns
array
getExpire ( )

Get Expire.

Returns
int
getSound ( )

Get Sound.

Returns
string
setAlert (   $text,
  $actionLocKey = null,
  $locKey = null,
  $locArgs = null,
  $launchImage = null 
)

Set Alert.

Parameters
string$text
string$actionLocKey
string$locKey
array$locArgs
string$launchImage
Returns
Zend_Mobile_Push_Message_Apns
setBadge (   $badge)

Set Badge.

Parameters
int$badge
Returns
Zend_Mobile_Push_Message_Apns
Exceptions
Zend_Mobile_Push_Message_Exception
setCustomData (   $array)

Set Custom Data.

Parameters
array$data
Returns
Zend_Mobile_Push_Message_Apns
Exceptions
Zend_Mobile_Push_Message_Exception
setExpire (   $expire)

Set Expire.

Parameters
int$expire
Returns
Zend_Mobile_Push_Message_Apns
Exceptions
Zend_Mobile_Push_Message_Exception
setSound (   $sound)

Set Sound.

Parameters
string$sound
Returns
Zend_Mobile_Push_Message_Apns
Exceptions
Zend_Mobile_Push_Message_Exception
validate ( )

Validate this is a proper Apns message.

Returns
boolean

Implements Zend_Mobile_Push_Message_Interface.

Member Data Documentation

$_alert = array()
protected
$_badge
protected
$_custom = array()
protected
$_expire
protected
$_sound = 'default'
protected