PHP Класс LaravelFCM\Response\TopicResponse

Наследование: extends BaseResponse, implements LaravelFCM\Response\TopicResponseContract
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$error string
$messageId string
$needRetry boolean
$topic string

Открытые методы

Метод Описание
__construct ( Response $response, Topics $topic ) TopicResponse constructor.
error ( ) : string return error message you should test if it's necessary to resent it
isSuccess ( ) : boolean true if topic sent with success
shouldRetry ( ) : boolean return true if it's necessary resent it using exponential backoff

Защищенные методы

Метод Описание
logResponse ( ) Log the response
parseResponse ( $responseInJson ) parse the response

Приватные методы

Метод Описание
parseError ( $responseInJson )
parseSuccess ( $responseInJson )

Описание методов

__construct() публичный Метод

TopicResponse constructor.
public __construct ( Response $response, Topics $topic )
$response GuzzleHttp\Psr7\Response
$topic LaravelFCM\Message\Topics

error() публичный Метод

return error message you should test if it's necessary to resent it
public error ( ) : string
Результат string error

isSuccess() публичный Метод

true if topic sent with success
public isSuccess ( ) : boolean
Результат boolean

logResponse() защищенный Метод

Log the response
protected logResponse ( )

parseResponse() защищенный Метод

parse the response
protected parseResponse ( $responseInJson )
$responseInJson

shouldRetry() публичный Метод

return true if it's necessary resent it using exponential backoff
public shouldRetry ( ) : boolean
Результат boolean

Описание свойств

$error защищенное свойство

protected string $error
Результат string

$messageId защищенное свойство

protected string $messageId
Результат string

$needRetry защищенное свойство

protected bool $needRetry
Результат boolean

$topic защищенное свойство

protected string $topic
Результат string