Skip to content
This repository was archived by the owner on Jun 28, 2024. It is now read-only.

Commit 1e8ea17

Browse files
authored
Merge pull request brozot#149 from vigneshgurusamy/vignesh/readme-patch
Readme update for downstream message error response codes
2 parents 418dc96 + e01be8b commit 1e8ea17

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ To get the latest version of Laravel-FCM on your project, require it from "compo
2626

2727
Or you can add it directly in your composer.json file:
2828

29-
30-
{
31-
"require": {
32-
"brozot/laravel-fcm": "1.2.*"
33-
}
34-
}
29+
```json
30+
{
31+
"require": {
32+
"brozot/laravel-fcm": "1.2.*"
33+
}
34+
}
35+
```
3536

3637

3738
### Laravel
@@ -148,16 +149,17 @@ $downstreamResponse->numberSuccess();
148149
$downstreamResponse->numberFailure();
149150
$downstreamResponse->numberModification();
150151

151-
//return Array - you must remove all this tokens in your database
152+
// return Array - you must remove all this tokens in your database
152153
$downstreamResponse->tokensToDelete();
153154

154-
//return Array (key : oldToken, value : new token - you must change the token in your database )
155+
// return Array (key : oldToken, value : new token - you must change the token in your database)
155156
$downstreamResponse->tokensToModify();
156157

157-
//return Array - you should try to resend the message to the tokens in the array
158+
// return Array - you should try to resend the message to the tokens in the array
158159
$downstreamResponse->tokensToRetry();
159160

160-
// return Array (key:token, value:errror) - in production you should remove from your database the tokens
161+
// return Array (key:token, value:error) - in production you should remove from your database the tokens
162+
$downstreamResponse->tokensWithError();
161163
```
162164

163165
#### Sending a Downstream Message to Multiple Devices
@@ -186,19 +188,21 @@ $downstreamResponse->numberSuccess();
186188
$downstreamResponse->numberFailure();
187189
$downstreamResponse->numberModification();
188190

189-
//return Array - you must remove all this tokens in your database
191+
// return Array - you must remove all this tokens in your database
190192
$downstreamResponse->tokensToDelete();
191193

192-
//return Array (key : oldToken, value : new token - you must change the token in your database )
194+
// return Array (key : oldToken, value : new token - you must change the token in your database)
193195
$downstreamResponse->tokensToModify();
194196

195-
//return Array - you should try to resend the message to the tokens in the array
197+
// return Array - you should try to resend the message to the tokens in the array
196198
$downstreamResponse->tokensToRetry();
197199

198-
// return Array (key:token, value:errror) - in production you should remove from your database the tokens present in this array
200+
// return Array (key:token, value:error) - in production you should remove from your database the tokens present in this array
199201
$downstreamResponse->tokensWithError();
200202
```
201203

204+
> Kindly refer [Downstream message error response codes](https://firebase.google.com/docs/cloud-messaging/http-server-ref#error-codes) documentation for more information.
205+
202206
### Topics Messages
203207

204208
A topics message is a notification message, data message, or both, that you send to all the devices registered to this topic.

0 commit comments

Comments
 (0)