PHP Class SimpleSoftwareIO\SMS\Drivers\EZTextingSMS

Inheritance: extends AbstractSMS, implements SimpleSoftwareIO\SMS\Drivers\DriverInterface, use trait SimpleSoftwareIO\SMS\MakesRequests
Afficher le fichier Open project: simplesoftwareio/simple-sms Class Usage Examples

Protected Properties

Свойство Type Description
$apiBase string The API's URL.
$apiEnding array The ending of the URL that all requests must have.
$client GuzzleHttp\Client The Guzzle HTTP Client.

Méthodes publiques

Méthode Description
__construct ( Client $client ) Constructs a new 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 ) Sends a SMS message.

Méthodes protégées

Méthode Description
processReceive ( $rawMessage ) : mixed | IncomingMessage Returns an IncomingMessage object with it's properties filled out.

Method Details

__construct() public méthode

Constructs a new instance.
public __construct ( Client $client )
$client GuzzleHttp\Client

checkMessages() public méthode

Checks the server for messages and returns their results.
public checkMessages ( array $options = [] ) : array
$options array
Résultat array

getMessage() public méthode

Gets a single message by it's ID.
public getMessage ( string | integer $messageId ) : IncomingMessage
$messageId string | integer
Résultat SimpleSoftwareIO\SMS\IncomingMessage

processReceive() protected méthode

Returns an IncomingMessage object with it's properties filled out.
protected processReceive ( $rawMessage ) : mixed | IncomingMessage
$rawMessage
Résultat mixed | SimpleSoftwareIO\SMS\IncomingMessage

receive() public méthode

Receives an incoming message via REST call.
public receive ( mixed $raw ) : IncomingMessage
$raw mixed
Résultat SimpleSoftwareIO\SMS\IncomingMessage

send() public méthode

Sends a SMS message.
public send ( OutgoingMessage $message )
$message SimpleSoftwareIO\SMS\OutgoingMessage

Property Details

$apiBase protected_oe property

The API's URL.
protected string $apiBase
Résultat string

$apiEnding protected_oe property

The ending of the URL that all requests must have.
protected array $apiEnding
Résultat array

$client protected_oe property

The Guzzle HTTP Client.
protected Client,GuzzleHttp $client
Résultat GuzzleHttp\Client