update v1.0.7.9 R.C.

This is a Release Candidate. We are still testing.

vendor/brozot/laravel-fcm/doc/LaravelFCM-Response-TopicResponse.md

@@ -0,0 +1,170 @@
+LaravelFCM\Response\TopicResponse
+===============
+
+Class TopicResponse
+
+
+
+
+* Class name: TopicResponse
+* Namespace: LaravelFCM\Response
+* Parent class: [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
+
+
+
+Constants
+----------
+
+
+### LIMIT_RATE_TOPICS_EXCEEDED
+
+    const LIMIT_RATE_TOPICS_EXCEEDED = "TopicsMessageRateExceeded"
+
+
+
+
+
+### SUCCESS
+
+    const SUCCESS = 'success'
+
+
+
+
+
+### FAILURE
+
+    const FAILURE = 'failure'
+
+
+
+
+
+### ERROR
+
+    const ERROR = "error"
+
+
+
+
+
+### MESSAGE_ID
+
+    const MESSAGE_ID = "message_id"
+
+
+
+
+
+
+
+Methods
+-------
+
+
+### __construct
+
+    mixed LaravelFCM\Response\BaseResponse::__construct(\GuzzleHttp\Psr7\Response $response)
+
+BaseResponse constructor.
+
+
+
+* Visibility: **public**
+* This method is defined by [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
+
+
+#### Arguments
+* $response **GuzzleHttp\Psr7\Response**
+
+
+
+### parseResponse
+
+    mixed LaravelFCM\Response\BaseResponse::parseResponse(array $responseInJson)
+
+parse the response
+
+
+
+* Visibility: **protected**
+* This method is **abstract**.
+* This method is defined by [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
+
+
+#### Arguments
+* $responseInJson **array**
+
+
+
+### logResponse
+
+    mixed LaravelFCM\Response\BaseResponse::logResponse()
+
+Log the response
+
+
+
+* Visibility: **protected**
+* This method is **abstract**.
+* This method is defined by [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
+
+
+
+
+### isSuccess
+
+    boolean LaravelFCM\Response\TopicResponse::isSuccess()
+
+true if topic sent with success
+
+
+
+* Visibility: **public**
+
+
+
+
+### error
+
+    string LaravelFCM\Response\TopicResponse::error()
+
+return error message
+you should test if it's necessary to resent it
+
+
+
+* Visibility: **public**
+
+
+
+
+### shouldRetry
+
+    boolean LaravelFCM\Response\TopicResponse::shouldRetry()
+
+return true if it's necessary resent it using exponential backoff
+
+
+
+* Visibility: **public**
+
+
+
+
+### isJsonResponse
+
+    mixed LaravelFCM\Response\BaseResponse::isJsonResponse(\GuzzleHttp\Psr7\Response $response)
+
+Check if the response given by fcm is parsable
+
+
+
+* Visibility: **private**
+* This method is defined by [LaravelFCM\Response\BaseResponse](LaravelFCM-Response-BaseResponse.md)
+
+
+#### Arguments
+* $response **GuzzleHttp\Psr7\Response**
+
+