Mobile/Push/Response/Gcm.php

Show:

inherited

Classes
- \Zend_Mobile_Push_Response_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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mobile
Subpackage: Zend_Mobile_Push
Version: $Id$

\Zend_Mobile_Push_Response_Gcm
jump to top

Package: Zend_Mobile\Zend_Mobile_Push

Gcm Response

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id$

Constants

 
                RESULT_MESSAGE_ID
                = 'message_id'

 
                RESULT_ERROR
                = 'error'

 
                RESULT_CANONICAL
                = 'registration_id'

Properties

int $_canonicalCnt

Canonical registration id count

Details

Type: int

int $_failureCnt

Failure Count

Details

Type: int

int $_id

Multicast ID

Details

Type: int

\Zend_Mobile_Push_Message_Gcm $_message

Message

Details

Type: \Zend_Mobile_Push_Message_Gcm

array $_response

Raw Response

Details

Type: array

array $_results

Results

Details

Type: array

int $_successCnt

Success Count

Details

Type: int

Methods

__construct(string $responseString = null, \Zend_Mobile_Push_Message_Gcm $message = null) : \Zend_Mobile_Push_Response_Gcm

Constructor

Parameters

Name	Type	Description
$responseString	string	JSON encoded response
$message	\Zend_Mobile_Push_Message_Gcm

Returns

Type	Description
\Zend_Mobile_Push_Response_Gcm

Throws

Exception	Description
\Zend_Mobile_Push_Exception_ServerUnavailable

_correlate() : array

Correlate Message and Result

Returns

Type	Description
array

getCanonicalCount() : int

Get Canonical Count

Returns

Type	Description
int

getFailureCount() : int

Get Failure Count

Returns

Type	Description
int

getMessage() : \Zend_Mobile_Push_Message_Gcm

Get Message

Returns

Type	Description
\Zend_Mobile_Push_Message_Gcm

getResponse() : array

Get Response

Returns

Type	Description
array

getResult(int $flag) : array

Get Singular Result

Parameters

Name	Type	Description
$flag	int	one of the RESULT_ flags*

Returns

Type	Description
array	singular array with keys being registration id value is the type of result

getResults() : array

Get Results

Returns

Type	Description
array	multi dimensional array of: NOTE: key is registration_id if the message is passed. 'registration_id' => array( 'message_id' => 'id', 'error' => 'error', 'registration_id' => 'id' )

getSuccessCount() : int

Get Success Count

Returns

Type	Description
int

setMessage(\Zend_Mobile_Push_Message_Gcm $message) : \Zend_Mobile_Push_Response_Gcm

Set Message

Parameters

Name	Type	Description
$message	\Zend_Mobile_Push_Message_Gcm

Returns

Type	Description
\Zend_Mobile_Push_Response_Gcm

setResponse(array $response) : \Zend_Mobile_Push_Response_Gcm

Set Response

Parameters

Name	Type	Description
$response	array

Returns

Type	Description
\Zend_Mobile_Push_Response_Gcm

Mobile/Push/Response/Gcm.php

\Zend_Mobile_Push_Response_Gcmjump to top

Constants

Properties

Methods

\Zend_Mobile_Push_Response_Gcm
jump to top