update 1.0.8.0

Commits for version update
This commit is contained in:
Manish Verma
2016-10-17 12:02:27 +05:30
parent dec927987b
commit 76e85db070
9674 changed files with 495757 additions and 58922 deletions

View File

@@ -9,7 +9,7 @@ Class DownstreamResponse
* Class name: DownstreamResponse
* Namespace: LaravelFCM\Response
* Parent class: [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
* This class implements: [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
Constants
@@ -171,13 +171,14 @@ parse the response
### merge
mixed LaravelFCM\Response\DownstreamResponse::merge(\LaravelFCM\Response\DownstreamResponse $response)
mixed LaravelFCM\Response\DownstreamResponseContract::merge(\LaravelFCM\Response\DownstreamResponse $response)
Merge two response
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
#### Arguments
@@ -187,59 +188,63 @@ Merge two response
### numberSuccess
integer LaravelFCM\Response\DownstreamResponse::numberSuccess()
integer LaravelFCM\Response\DownstreamResponseContract::numberSuccess()
Get the number of device reached with success
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### numberFailure
integer LaravelFCM\Response\DownstreamResponse::numberFailure()
integer LaravelFCM\Response\DownstreamResponseContract::numberFailure()
Get the number of device which thrown an error
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### numberModification
integer LaravelFCM\Response\DownstreamResponse::numberModification()
integer LaravelFCM\Response\DownstreamResponseContract::numberModification()
Get the number of device that you need to modify their token
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### tokensToDelete
array LaravelFCM\Response\DownstreamResponse::tokensToDelete()
array LaravelFCM\Response\DownstreamResponseContract::tokensToDelete()
get token to delete
remove all tokens returned by this method in your database
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### tokensToModify
array LaravelFCM\Response\DownstreamResponse::tokensToModify()
array LaravelFCM\Response\DownstreamResponseContract::tokensToModify()
get token to modify
@@ -249,26 +254,28 @@ value: new token
find the old token in your database and replace it with the new one
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### tokensToRetry
array LaravelFCM\Response\DownstreamResponse::tokensToRetry()
array LaravelFCM\Response\DownstreamResponseContract::tokensToRetry()
Get tokens that you should resend using exponential backoof
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### tokensWithError
array LaravelFCM\Response\DownstreamResponse::tokensWithError()
array LaravelFCM\Response\DownstreamResponseContract::tokensWithError()
Get tokens that thrown an error
@@ -278,13 +285,14 @@ value : error
In production, remove these tokens from you database
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### hasMissingToken
boolean LaravelFCM\Response\DownstreamResponse::hasMissingToken()
boolean LaravelFCM\Response\DownstreamResponseContract::hasMissingToken()
check if missing tokens was given to the request
If true, remove all the empty token in your database
@@ -292,6 +300,7 @@ If true, remove all the empty token in your database
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)

View File

@@ -0,0 +1,147 @@
LaravelFCM\Response\DownstreamResponseContract
===============
Interface DownstreamResponseContract
* Interface name: DownstreamResponseContract
* Namespace: LaravelFCM\Response
* This is an **interface**
Methods
-------
### merge
mixed LaravelFCM\Response\DownstreamResponseContract::merge(\LaravelFCM\Response\DownstreamResponse $response)
Merge two response
* Visibility: **public**
#### Arguments
* $response **[LaravelFCM\Response\DownstreamResponse](LaravelFCM-Response-DownstreamResponse.md)**
### numberSuccess
integer LaravelFCM\Response\DownstreamResponseContract::numberSuccess()
Get the number of device reached with success
* Visibility: **public**
### numberFailure
integer LaravelFCM\Response\DownstreamResponseContract::numberFailure()
Get the number of device which thrown an error
* Visibility: **public**
### numberModification
integer LaravelFCM\Response\DownstreamResponseContract::numberModification()
Get the number of device that you need to modify their token
* Visibility: **public**
### tokensToDelete
array LaravelFCM\Response\DownstreamResponseContract::tokensToDelete()
get token to delete
remove all tokens returned by this method in your database
* Visibility: **public**
### tokensToModify
array LaravelFCM\Response\DownstreamResponseContract::tokensToModify()
get token to modify
key: oldToken
value: new token
find the old token in your database and replace it with the new one
* Visibility: **public**
### tokensToRetry
array LaravelFCM\Response\DownstreamResponseContract::tokensToRetry()
Get tokens that you should resend using exponential backoof
* Visibility: **public**
### tokensWithError
array LaravelFCM\Response\DownstreamResponseContract::tokensWithError()
Get tokens that thrown an error
key : token
value : error
In production, remove these tokens from you database
* Visibility: **public**
### hasMissingToken
boolean LaravelFCM\Response\DownstreamResponseContract::hasMissingToken()
check if missing tokens was given to the request
If true, remove all the empty token in your database
* Visibility: **public**

View File

@@ -9,7 +9,7 @@ Class GroupResponse
* Class name: GroupResponse
* Namespace: LaravelFCM\Response
* Parent class: [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
* This class implements: [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
Constants
@@ -114,39 +114,42 @@ Log the response
### numberSuccess
integer LaravelFCM\Response\GroupResponse::numberSuccess()
integer LaravelFCM\Response\GroupResponseContract::numberSuccess()
Get the number of device reached with success
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
### numberFailure
integer LaravelFCM\Response\GroupResponse::numberFailure()
integer LaravelFCM\Response\GroupResponseContract::numberFailure()
Get the number of device which thrown an error
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
### tokensFailed
array LaravelFCM\Response\GroupResponse::tokensFailed()
array LaravelFCM\Response\GroupResponseContract::tokensFailed()
Get all token in group that fcm cannot reach
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)

View File

@@ -0,0 +1,59 @@
LaravelFCM\Response\GroupResponseContract
===============
Interface GroupResponseContract
* Interface name: GroupResponseContract
* Namespace: LaravelFCM\Response
* This is an **interface**
Methods
-------
### numberSuccess
integer LaravelFCM\Response\GroupResponseContract::numberSuccess()
Get the number of device reached with success
* Visibility: **public**
### numberFailure
integer LaravelFCM\Response\GroupResponseContract::numberFailure()
Get the number of device which thrown an error
* Visibility: **public**
### tokensFailed
array LaravelFCM\Response\GroupResponseContract::tokensFailed()
Get all token in group that fcm cannot reach
* Visibility: **public**

View File

@@ -9,7 +9,7 @@ Class TopicResponse
* Class name: TopicResponse
* Namespace: LaravelFCM\Response
* Parent class: [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
* This class implements: [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
Constants
@@ -114,20 +114,21 @@ Log the response
### isSuccess
boolean LaravelFCM\Response\TopicResponse::isSuccess()
boolean LaravelFCM\Response\TopicResponseContract::isSuccess()
true if topic sent with success
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
### error
string LaravelFCM\Response\TopicResponse::error()
string LaravelFCM\Response\TopicResponseContract::error()
return error message
you should test if it's necessary to resent it
@@ -135,19 +136,21 @@ you should test if it's necessary to resent it
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
### shouldRetry
boolean LaravelFCM\Response\TopicResponse::shouldRetry()
boolean LaravelFCM\Response\TopicResponseContract::shouldRetry()
return true if it's necessary resent it using exponential backoff
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)

View File

@@ -0,0 +1,60 @@
LaravelFCM\Response\TopicResponseContract
===============
Interface TopicResponseContract
* Interface name: TopicResponseContract
* Namespace: LaravelFCM\Response
* This is an **interface**
Methods
-------
### isSuccess
boolean LaravelFCM\Response\TopicResponseContract::isSuccess()
true if topic sent with success
* Visibility: **public**
### error
string LaravelFCM\Response\TopicResponseContract::error()
return error message
you should test if it's necessary to resent it
* Visibility: **public**
### shouldRetry
boolean LaravelFCM\Response\TopicResponseContract::shouldRetry()
return true if it's necessary resent it using exponential backoff
* Visibility: **public**

View File

@@ -0,0 +1,254 @@
LaravelFCM\Test\Mocks\MockDownstreamResponse
===============
Class MockDownstreamResponse **Only use it for testing**
* Class name: MockDownstreamResponse
* Namespace: LaravelFCM\Test\Mocks
* This class implements: [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
Methods
-------
### __construct
mixed LaravelFCM\Test\Mocks\MockDownstreamResponse::__construct($numberSuccess)
DownstreamResponse constructor.
* Visibility: **public**
#### Arguments
* $numberSuccess **mixed**
### merge
mixed LaravelFCM\Response\DownstreamResponseContract::merge(\LaravelFCM\Response\DownstreamResponse $response)
Merge two response
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
#### Arguments
* $response **[LaravelFCM\Response\DownstreamResponse](LaravelFCM-Response-DownstreamResponse.md)**
### numberSuccess
integer LaravelFCM\Response\DownstreamResponseContract::numberSuccess()
Get the number of device reached with success
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### numberFailure
integer LaravelFCM\Response\DownstreamResponseContract::numberFailure()
Get the number of device which thrown an error
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### numberModification
integer LaravelFCM\Response\DownstreamResponseContract::numberModification()
Get the number of device that you need to modify their token
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### addTokenToDelete
mixed LaravelFCM\Test\Mocks\MockDownstreamResponse::addTokenToDelete($token)
Add a token to delete
* Visibility: **public**
#### Arguments
* $token **mixed**
### tokensToDelete
array LaravelFCM\Response\DownstreamResponseContract::tokensToDelete()
get token to delete
remove all tokens returned by this method in your database
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### addTokenToModify
mixed LaravelFCM\Test\Mocks\MockDownstreamResponse::addTokenToModify($oldToken, $newToken)
Add a token to modify
* Visibility: **public**
#### Arguments
* $oldToken **mixed**
* $newToken **mixed**
### tokensToModify
array LaravelFCM\Response\DownstreamResponseContract::tokensToModify()
get token to modify
key: oldToken
value: new token
find the old token in your database and replace it with the new one
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### addTokenToRetry
mixed LaravelFCM\Test\Mocks\MockDownstreamResponse::addTokenToRetry($token)
Add a token to retry
* Visibility: **public**
#### Arguments
* $token **mixed**
### tokensToRetry
array LaravelFCM\Response\DownstreamResponseContract::tokensToRetry()
Get tokens that you should resend using exponential backoof
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### addTokenWithError
mixed LaravelFCM\Test\Mocks\MockDownstreamResponse::addTokenWithError($token, $message)
Add a token to errors
* Visibility: **public**
#### Arguments
* $token **mixed**
* $message **mixed**
### tokensWithError
array LaravelFCM\Response\DownstreamResponseContract::tokensWithError()
Get tokens that thrown an error
key : token
value : error
In production, remove these tokens from you database
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
### setMissingToken
mixed LaravelFCM\Test\Mocks\MockDownstreamResponse::setMissingToken($hasMissingToken)
change missing token state
* Visibility: **public**
#### Arguments
* $hasMissingToken **mixed**
### hasMissingToken
boolean LaravelFCM\Response\DownstreamResponseContract::hasMissingToken()
check if missing tokens was given to the request
If true, remove all the empty token in your database
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)

View File

@@ -0,0 +1,110 @@
LaravelFCM\Test\Mocks\MockGroupResponse
===============
Class MockGroupResponse **Only use it for testing**
* Class name: MockGroupResponse
* Namespace: LaravelFCM\Test\Mocks
* This class implements: [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
Methods
-------
### setNumberSuccess
mixed LaravelFCM\Test\Mocks\MockGroupResponse::setNumberSuccess($numberSuccess)
set number of success
* Visibility: **public**
#### Arguments
* $numberSuccess **mixed**
### numberSuccess
integer LaravelFCM\Response\GroupResponseContract::numberSuccess()
Get the number of device reached with success
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
### setNumberFailure
mixed LaravelFCM\Test\Mocks\MockGroupResponse::setNumberFailure($numberFailures)
set number of failures
* Visibility: **public**
#### Arguments
* $numberFailures **mixed**
### numberFailure
integer LaravelFCM\Response\GroupResponseContract::numberFailure()
Get the number of device which thrown an error
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
### addTokenFailed
mixed LaravelFCM\Test\Mocks\MockGroupResponse::addTokenFailed($tokenFailed)
add a token to the failed list
* Visibility: **public**
#### Arguments
* $tokenFailed **mixed**
### tokensFailed
array LaravelFCM\Response\GroupResponseContract::tokensFailed()
Get all token in group that fcm cannot reach
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)

View File

@@ -0,0 +1,95 @@
LaravelFCM\Test\Mocks\MockTopicResponse
===============
Class MockTopicResponse **Only use it for testing**
* Class name: MockTopicResponse
* Namespace: LaravelFCM\Test\Mocks
* This class implements: [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
Methods
-------
### setSuccess
mixed LaravelFCM\Test\Mocks\MockTopicResponse::setSuccess($messageId)
if success set a message id
* Visibility: **public**
#### Arguments
* $messageId **mixed**
### isSuccess
boolean LaravelFCM\Response\TopicResponseContract::isSuccess()
true if topic sent with success
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
### setError
mixed LaravelFCM\Test\Mocks\MockTopicResponse::setError($error)
set error
* Visibility: **public**
#### Arguments
* $error **mixed**
### error
string LaravelFCM\Response\TopicResponseContract::error()
return error message
you should test if it's necessary to resent it
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
### shouldRetry
boolean LaravelFCM\Response\TopicResponseContract::shouldRetry()
return true if it's necessary resent it using exponential backoff
* Visibility: **public**
* This method is defined by [LaravelFCM\Response\TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)

View File

@@ -21,10 +21,18 @@ API Index
* LaravelFCM\Response
* [BaseResponse](LaravelFCM-Response-BaseResponse.md)
* [DownstreamResponse](LaravelFCM-Response-DownstreamResponse.md)
* [DownstreamResponseContract](LaravelFCM-Response-DownstreamResponseContract.md)
* LaravelFCM\Response\Exceptions
* [InvalidRequestException](LaravelFCM-Response-Exceptions-InvalidRequestException.md)
* [ServerResponseException](LaravelFCM-Response-Exceptions-ServerResponseException.md)
* [UnauthorizedRequestException](LaravelFCM-Response-Exceptions-UnauthorizedRequestException.md)
* [GroupResponse](LaravelFCM-Response-GroupResponse.md)
* [GroupResponseContract](LaravelFCM-Response-GroupResponseContract.md)
* [TopicResponse](LaravelFCM-Response-TopicResponse.md)
* [TopicResponseContract](LaravelFCM-Response-TopicResponseContract.md)
* LaravelFCM\Test
* LaravelFCM\Test\Mocks
* [MockDownstreamResponse](LaravelFCM-Test-Mocks-MockDownstreamResponse.md)
* [MockGroupResponse](LaravelFCM-Test-Mocks-MockGroupResponse.md)
* [MockTopicResponse](LaravelFCM-Test-Mocks-MockTopicResponse.md)