Mobile/Push/Message/Apns.php

Show:

inherited

Classes
- \Zend_Mobile_Push_Message_Apns

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_Apns
jump to top

Package: Zend\Mobile\Zend\Mobile\Push

Apns 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 $_alert = array()

Alert

Default valuearray()Details

Type: array

int $_badge =

Badge Number

Details

Type: int

array $_custom = array()

Custom Data

Default valuearray()Details

Type: array

int $_expire =

Expiration

Details

Type: int

\scalar $_id =

inherited

Inherited from: \Zend_Mobile_Push_Message_Abstract::$$_id

Details

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

string $_sound = 'default'

Sound

Default value'default'Details

Type: string

string $_token =

inherited

Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::$$_token

Details

Type: string
Inherited_from: \Zend_Mobile_Push_Message_Abstract::$$_token

Methods

addCustomData(string $key, mixed $value) : \Zend_Mobile_Push_Message_Apns

Add Custom Data

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Mobile_Push_Message_Apns

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

clearCustomData() : \throw

Clear Custom Data

Returns

Type	Description
\throw	new Zend_Mobile_Push_Message_Apns

getAlert() : array

Get Alert

Returns

Type	Description
array

getBadge() : int

Get Badge

Returns

Type	Description
int

getCustomData() : array

Get Custom Data

Returns

Type	Description
array

getExpire() : int

Get Expire

Returns

Type	Description
int

getId() : \scalar

inherited

Get Message ID

Inherited from: \Zend_Mobile_Push_Message_Abstract::getId()

Returns

Type	Description
\scalar

getSound() : string

Get Sound

Returns

Type	Description
string

getToken() : string

inherited

Get Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::getToken()

Returns

Type	Description
string

setAlert(string $text, string $actionLocKey = null, string $locKey = null, array $locArgs = null, string $launchImage = null) : \Zend_Mobile_Push_Message_Apns

Set Alert

Parameters

Name	Type	Description
$text	string
$actionLocKey	string
$locKey	string
$locArgs	array
$launchImage	string

Returns

Type	Description
\Zend_Mobile_Push_Message_Apns

setBadge(int $badge) : \Zend_Mobile_Push_Message_Apns

Set Badge

Parameters

Name	Type	Description
$badge	int

Returns

Type	Description
\Zend_Mobile_Push_Message_Apns

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

setCustomData( $array) : \Zend_Mobile_Push_Message_Apns

Set Custom Data

Parameters

Name	Type	Description
$array

Returns

Type	Description
\Zend_Mobile_Push_Message_Apns

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

setExpire(int $expire) : \Zend_Mobile_Push_Message_Apns

Set Expire

Parameters

Name	Type	Description
$expire	int

Returns

Type	Description
\Zend_Mobile_Push_Message_Apns

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

setSound(string $sound) : \Zend_Mobile_Push_Message_Apns

Set Sound

Parameters

Name	Type	Description
$sound	string

Returns

Type	Description
\Zend_Mobile_Push_Message_Apns

Throws

Exception	Description
\Zend_Mobile_Push_Message_Exception

setToken(string $token) : \Zend_Mobile_Push_Message_Abstract

inherited

Set Token

Inherited from: \Zend_Mobile_Push_Message_Abstract::setToken()

Parameters

Name	Type	Description
$token	string

Returns

Type	Description
\Zend_Mobile_Push_Message_Abstract

validate() : boolean

Validate this is a proper Apns message

Returns

Type	Description
boolean

Mobile/Push/Message/Apns.php

\Zend_Mobile_Push_Message_Apnsjump to top

Properties

Methods

\Zend_Mobile_Push_Message_Apns
jump to top