PHP Class LaravelFCM\Mocks\MockDownstreamResponse

Inheritance: implements LaravelFCM\Response\DownstreamResponseContract
Show file Open project: brozot/laravel-fcm

Protected Properties

Property Type Description
$hasMissingToken boolean
$messageId
$numberTokensSuccess integer
$tokensToDelete array
$tokensToModify array
$tokensToRetry array
$tokensWithError array

Public Methods

Method Description
__construct ( $numberSuccess ) DownstreamResponse constructor.
addTokenToDelete ( $token ) Add a token to delete
addTokenToModify ( $oldToken, $newToken ) Add a token to modify
addTokenToRetry ( $token ) Add a token to retry
addTokenWithError ( $token, $message ) Add a token to errors
hasMissingToken ( ) : boolean check if missing tokens was given to the request If true, remove all the empty token in your database
merge ( DownstreamResponse $response ) Not using it
numberFailure ( ) : integer Get the number of device which thrown an error
numberModification ( ) : integer Get the number of device that you need to modify their token
numberSuccess ( ) : integer Get the number of device reached with success + numberTokenToModify
setMissingToken ( $hasMissingToken ) change missing token state
tokensToDelete ( ) : array get token to delete remove all tokens returned by this method in your database
tokensToModify ( ) : array get token to modify key: oldToken value: new token find the old token in your database and replace it with the new one
tokensToRetry ( ) : array Get tokens that you should resend using exponential backoof
tokensWithError ( ) : array Get tokens that thrown an error key : token value : error In production, remove these tokens from you database

Method Details

__construct() public method

DownstreamResponse constructor.
public __construct ( $numberSuccess )
$numberSuccess

addTokenToDelete() public method

Add a token to delete
public addTokenToDelete ( $token )
$token

addTokenToModify() public method

Add a token to modify
public addTokenToModify ( $oldToken, $newToken )
$oldToken
$newToken

addTokenToRetry() public method

Add a token to retry
public addTokenToRetry ( $token )
$token

addTokenWithError() public method

Add a token to errors
public addTokenWithError ( $token, $message )
$token
$message

hasMissingToken() public method

check if missing tokens was given to the request If true, remove all the empty token in your database
public hasMissingToken ( ) : boolean
return boolean

merge() public method

Not using it
public merge ( DownstreamResponse $response )
$response LaravelFCM\Response\DownstreamResponse

numberFailure() public method

Get the number of device which thrown an error
public numberFailure ( ) : integer
return integer

numberModification() public method

Get the number of device that you need to modify their token
public numberModification ( ) : integer
return integer

numberSuccess() public method

Get the number of device reached with success + numberTokenToModify
public numberSuccess ( ) : integer
return integer

setMissingToken() public method

change missing token state
public setMissingToken ( $hasMissingToken )
$hasMissingToken

tokensToDelete() public method

get token to delete remove all tokens returned by this method in your database
public tokensToDelete ( ) : array
return array

tokensToModify() public method

get token to modify key: oldToken value: new token find the old token in your database and replace it with the new one
public tokensToModify ( ) : array
return array

tokensToRetry() public method

Get tokens that you should resend using exponential backoof
public tokensToRetry ( ) : array
return array

tokensWithError() public method

Get tokens that thrown an error key : token value : error In production, remove these tokens from you database
public tokensWithError ( ) : array
return array

Property Details

$hasMissingToken protected property

protected bool $hasMissingToken
return boolean

$messageId protected property

protected $messageId

$numberTokensSuccess protected property

protected int $numberTokensSuccess
return integer

$tokensToDelete protected property

protected array $tokensToDelete
return array

$tokensToModify protected property

protected array $tokensToModify
return array

$tokensToRetry protected property

protected array $tokensToRetry
return array

$tokensWithError protected property

protected array $tokensWithError
return array