PHP Класс SimpleSoftwareIO\SMS\Drivers\FlowrouteSMS

Наследование: extends AbstractSMS, implements SimpleSoftwareIO\SMS\Drivers\DriverInterface, use trait SimpleSoftwareIO\SMS\MakesRequests
Показать файл Открыть проект

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

Свойство Тип Описание
$apiBase string The API's URL.
$client GuzzleHttp\Client The Guzzle HTTP Client.

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

Метод Описание
__construct ( Client $client, $accessKey, $secretKey ) Create the Flowroute instance.
checkMessages ( array $options = [] ) : array Checks the server for messages and returns their results.
getMessage ( string | integer $messageId ) : IncomingMessage Gets a single message by it's ID.
receive ( mixed $raw ) : IncomingMessage Receives an incoming message via REST call.
send ( OutgoingMessage $message ) : void Sends a SMS message.

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

Метод Описание
postRequest ( ) : mixed Creates and sends a POST request to the requested URL.
processReceive ( $rawMessage ) : mixed Creates many IncomingMessage objects and sets all of the properties.

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

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

Create the Flowroute instance.
public __construct ( Client $client, $accessKey, $secretKey )
$client GuzzleHttp\Client The Guzzle Client

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

See https://developer.flowroute.com/docs/lookup-a-set-of-messages
public checkMessages ( array $options = [] ) : array
$options array
Результат array

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

Gets a single message by it's ID.
public getMessage ( string | integer $messageId ) : IncomingMessage
$messageId string | integer
Результат SimpleSoftwareIO\SMS\IncomingMessage

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

Creates and sends a POST request to the requested URL.
protected postRequest ( ) : mixed
Результат mixed

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

Creates many IncomingMessage objects and sets all of the properties.
protected processReceive ( $rawMessage ) : mixed
$rawMessage
Результат mixed

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

Receives an incoming message via REST call.
public receive ( mixed $raw ) : IncomingMessage
$raw mixed
Результат SimpleSoftwareIO\SMS\IncomingMessage

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

Sends a SMS message.
public send ( OutgoingMessage $message ) : void
$message SimpleSoftwareIO\SMS\OutgoingMessage
Результат void

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

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

The API's URL.
protected string $apiBase
Результат string

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

The Guzzle HTTP Client.
protected Client,GuzzleHttp $client
Результат GuzzleHttp\Client