Mpns Tile Message

category Zend
package Zend_Mobile
subpackage Zend_Mobile_Push
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Mobile_Push_Message_Mpns

 Methods

Get Back Background Image

getBackBackgroundImage() : string

Returns

string

Get Back Content

getBackContent() : string

Returns

string

Get Back Title

getBackTitle() : string

Returns

string

Get Background Image

getBackgroundImage() : string

Returns

string

Get Count

getCount() : integer

Returns

integer

Get Delay

getDelay() : integer
inherited_from \Zend_Mobile_Push_Message_Mpns::getDelay()

Returns

integer

Get Delay

getDelay() : integer
Inherited

Returns

integer

Get Message ID

getId() : integer | string | float | boolean
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::getId()

Returns

integerstringfloatbooleanScalar

Get Notification Type

getNotificationType() : string
Static
inherited_from \Zend_Mobile_Push_Message_Mpns::getNotificationType()

Returns

string

Get Notification Type

getNotificationType() : string
InheritedStatic

Returns

string

Get Tile Id

getTileId() : string

Returns

string

Get Title

getTitle() : string

Returns

string

Get Token

getToken() : string
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::getToken()

Returns

string

Get XML Payload

getXmlPayload() : string
inherited_from \Zend_Mobile_Push_Message_Mpns::getXmlPayload()

Returns

string

Get XML Payload

getXmlPayload() : string
Inherited

Returns

string

Set Back Background Image

setBackBackgroundImage(string $bgImg) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$bgImg

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Back Content

setBackContent(string $content) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$content

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Back Title

setBackTitle(string $title) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$title

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Background Image

setBackgroundImage(string $bgImg) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$bgImg

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Count

setCount(integer $count) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$count

integer

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Delay

setDelay(integer $delay) : \Zend_Mobile_Push_Message_Mpns_Tile
inherited_from \Zend_Mobile_Push_Message_Mpns::setDelay()

Parameters

$delay

integer

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Delay

setDelay(integer $delay) : \Zend_Mobile_Push_Message_Mpns
Inherited

Parameters

$delay

integer

one of const DELAY_* of implementing classes

Returns

\Zend_Mobile_Push_Message_Mpns

Set Message ID

setId(integer|string|float|boolean $id) : \Zend_Mobile_Push_Message_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::setId()

Parameters

$id

integerstringfloatboolean

Scalar

Exceptions

\Exception

Returns

\Zend_Mobile_Push_Message_Abstract

Set Options

setOptions(array $options) : \Zend_Mobile_Push_Message_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::setOptions()

Parameters

$options

array

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Abstract

Set Tile Id

setTileId(string $tileId) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$tileId

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Title

setTitle(string $title) : \Zend_Mobile_Push_Message_Mpns_Tile

Parameters

$title

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Mpns_Tile

Set Token

setToken(string $token) : \Zend_Mobile_Push_Message_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::setToken()

Parameters

$token

string

Exceptions

\Zend_Mobile_Push_Message_Exception

Returns

\Zend_Mobile_Push_Message_Abstract

Validate proper mpns message

validate() : boolean
inherited_from \Zend_Mobile_Push_Message_Mpns::validate()

Returns

boolean

Validate Message format

validate() : boolean
Inherited
inherited_from \Zend_Mobile_Push_Message_Interface::validate()

Returns

boolean

 Properties

 

Back Background Image

$_backBackgroundImage : string

Default

 

Back Content

$_backContent : string

Default

 

Back Title

$_backTitle : string

Default

 

Background Image

$_backgroundImage : string

Default

 

Count

$_count : integer

Default

0
 

Delay

$_delay : integer

Default

 

Id

$_id : integer | string | float | boolean

Default

 

Tile ID

$_tileId : string

Default

 

Title

$_title : string

Default

 

Token

$_token : string

Default

 Constants

 

DELAY_450S

DELAY_450S = 11 
 

DELAY_900S

DELAY_900S = 21 
 

Mpns delays

DELAY_IMMEDIATE = 1 : integer
 

Mpns types

TYPE_RAW = 'raw' : string
 

TYPE_TILE

TYPE_TILE = 'token' 
 

TYPE_TOAST

TYPE_TOAST = 'toast'