interface SmsMessageInterface in SMS Framework 2.x
Same name in this branch
- 2.x src/Message/SmsMessageInterface.php \Drupal\sms\Message\SmsMessageInterface
- 2.x src/Entity/SmsMessageInterface.php \Drupal\sms\Entity\SmsMessageInterface
Same name and namespace in other branches
- 8 src/Message/SmsMessageInterface.php \Drupal\sms\Message\SmsMessageInterface
- 2.1.x src/Message/SmsMessageInterface.php \Drupal\sms\Message\SmsMessageInterface
Contains information about an SMS message.
Hierarchy
- interface \Drupal\sms\Message\SmsMessageInterface
Expanded class hierarchy of SmsMessageInterface
All classes that implement SmsMessageInterface
20 files declare their use of SmsMessageInterface
- AccountRegistration.php in modules/
sms_user/ src/ AccountRegistration.php - AccountRegistrationInterface.php in modules/
sms_user/ src/ AccountRegistrationInterface.php - DefaultCapabilities.php in tests/
modules/ sms_test_gateway/ src/ Plugin/ SmsGateway/ DefaultCapabilities.php - DefaultSmsProvider.php in src/
Provider/ DefaultSmsProvider.php - Incoming.php in tests/
modules/ sms_test_gateway/ src/ Plugin/ SmsGateway/ Incoming.php
File
- src/
Message/ SmsMessageInterface.php, line 12
Namespace
Drupal\sms\MessageView source
interface SmsMessageInterface {
/**
* Gets the list of recipients of this SMS message.
*
* @return array
* The list of recipients of this SMS message.
*/
public function getRecipients();
/**
* Adds a single recipient to the SMS message.
*
* @param string $recipient
* The recipient to add.
*
* @return $this
* The called SMS message object.
*/
public function addRecipient($recipient);
/**
* Adds multiple recipients to the SMS message.
*
* @param array $recipients
* An array of recipients to add.
*
* @return $this
* The called SMS message object.
*/
public function addRecipients(array $recipients);
/**
* Removes a single recipient from the SMS message.
*
* @param string $recipient
* The recipient to remove.
*
* @return $this
* The called SMS message object.
*/
public function removeRecipient($recipient);
/**
* Removes multiple recipients from the SMS message.
*
* @param array $recipients
* An array of recipients to remove.
*
* @return $this
* The called SMS message object.
*/
public function removeRecipients(array $recipients);
/**
* Get the gateway for this message.
*
* @return \Drupal\sms\Entity\SmsGatewayInterface|null
* A gateway plugin instance, or NULL to let the provider decide.
*/
public function getGateway();
/**
* Set the gateway for this message.
*
* @param \Drupal\sms\Entity\SmsGatewayInterface $gateway
* A gateway plugin instance.
*
* @return $this
* Return SMS message for chaining.
*/
public function setGateway(SmsGatewayInterface $gateway);
/**
* Get direction of the message.
*
* @return int
* See \Drupal\sms\Direction constants for potential values.
*/
public function getDirection();
/**
* Set direction of the message.
*
* @param int $direction
* Any of \Drupal\sms\Direction constants.
*
* @return $this
* Return SMS message for chaining.
*/
public function setDirection($direction);
/**
* Gets the options for building or sending this SMS message.
*
* @return array
* The options for building or sending this SMS message.
*/
public function getOptions();
/**
* Gets the option specified by the key $name.
*
* @param string $name
* The name of the option.
*
* @return mixed
* Get the value of the option.
*/
public function getOption($name);
/**
* Sets an option for this SMS message.
*
* @param string $name
* The name of the option.
* @param mixed $value
* The value of the option.
*
* @return $this
* The called SMS message object.
*/
public function setOption($name, $value);
/**
* Removes an option from this SMS message.
*
* @param string $name
* The name of the option.
*
* @return $this
* The called SMS message object.
*/
public function removeOption($name);
/**
* Get the result associated with this SMS message.
*
* @return \Drupal\sms\Message\SmsMessageResultInterface|null
* The result associated with this SMS message, or NULL if there is no
* result.
*/
public function getResult();
/**
* Set the result associated with this SMS message.
*
* @param \Drupal\sms\Message\SmsMessageResultInterface|null $result
* The result to associate with this SMS message, or NULL if there is no
* result.
*
* @return $this
* The called SMS message object.
*/
public function setResult(SmsMessageResultInterface $result = NULL);
/**
* Gets the name of the sender of this SMS message.
*
* @return string|null
* The name of the sender, or NULL if none is defined.
*/
public function getSender();
/**
* Set the name of the sender of this SMS message.
*
* @param string|null $sender
* The name of the sender.
*
* @return $this
* The called SMS message object.
*/
public function setSender($sender);
/**
* Get phone number of the sender.
*
* @return string
* The phone number of the sender.
*/
public function getSenderNumber();
/**
* Set the phone number of the sender.
*
* @param string $number
* The phone number of the sender.
*
* @return $this
* Return SMS message for chaining.
*/
public function setSenderNumber($number);
/**
* Gets the message to be sent.
*
* @return string
* The message to be sent.
*/
public function getMessage();
/**
* Set the message to be sent.
*
* @param string $message
* The message to be sent.
*
* @return $this
* The called SMS message object.
*/
public function setMessage($message);
/**
* Gets the UUID of the SMS object.
*
* @return string
* The UUID of the SMS object.
*/
public function getUuid();
/**
* Gets the user who created the SMS message.
*
* @return int|null
* The ID of the user who created the message. Or NULL if no user entity is
* associated as the sender.
*/
public function getUid();
/**
* Set the user who created the SMS message.
*
* @param int $uid
* The ID of a user entity.
*
* @return $this
* The called SMS message object.
*/
public function setUid($uid);
/**
* Sets whether this SMS message was generated automatically.
*
* @param bool $automated
* Whether this SMS message was generated automatically. Set to FALSE if the
* message is created due to direct action.
*
* @return $this
* The called SMS message object.
*/
public function setAutomated($automated);
/**
* Gets whether this SMS message was generated automatically.
*
* @return bool
* Whether this SMS message was generated automatically.
*/
public function isAutomated();
/**
* Split this SMS message into new messages by chunks of recipients.
*
* @param int $size
* The quantity of recipients to chunk by.
*
* @return static[]
* An array of SMS messages split by recipient chunks.
*/
public function chunkByRecipients($size);
/**
* Gets the delivery report for a particular recipient.
*
* @param string $recipient
* The number of the recipient for which the report is to be retrieved.
*
* @return \Drupal\sms\Message\SmsDeliveryReportInterface|null
* A delivery report object, or NULL if there is no report for the
* recipient.
*
* @see SmsMessageInterface::getReports()
*/
public function getReport($recipient);
/**
* Gets the delivery reports for all recipients.
*
* @return \Drupal\sms\Message\SmsDeliveryReportInterface[]
* An array of delivery reports.
*/
public function getReports();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SmsMessageInterface:: |
public | function | Adds a single recipient to the SMS message. | 2 |
SmsMessageInterface:: |
public | function | Adds multiple recipients to the SMS message. | 2 |
SmsMessageInterface:: |
public | function | Split this SMS message into new messages by chunks of recipients. | 2 |
SmsMessageInterface:: |
public | function | Get direction of the message. | 2 |
SmsMessageInterface:: |
public | function | Get the gateway for this message. | 2 |
SmsMessageInterface:: |
public | function | Gets the message to be sent. | 2 |
SmsMessageInterface:: |
public | function | Gets the option specified by the key $name. | 2 |
SmsMessageInterface:: |
public | function | Gets the options for building or sending this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Gets the list of recipients of this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Gets the delivery report for a particular recipient. | 2 |
SmsMessageInterface:: |
public | function | Gets the delivery reports for all recipients. | 2 |
SmsMessageInterface:: |
public | function | Get the result associated with this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Gets the name of the sender of this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Get phone number of the sender. | 2 |
SmsMessageInterface:: |
public | function | Gets the user who created the SMS message. | 2 |
SmsMessageInterface:: |
public | function | Gets the UUID of the SMS object. | 2 |
SmsMessageInterface:: |
public | function | Gets whether this SMS message was generated automatically. | 2 |
SmsMessageInterface:: |
public | function | Removes an option from this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Removes a single recipient from the SMS message. | 2 |
SmsMessageInterface:: |
public | function | Removes multiple recipients from the SMS message. | 2 |
SmsMessageInterface:: |
public | function | Sets whether this SMS message was generated automatically. | 2 |
SmsMessageInterface:: |
public | function | Set direction of the message. | 2 |
SmsMessageInterface:: |
public | function | Set the gateway for this message. | 2 |
SmsMessageInterface:: |
public | function | Set the message to be sent. | 2 |
SmsMessageInterface:: |
public | function | Sets an option for this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Set the result associated with this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Set the name of the sender of this SMS message. | 2 |
SmsMessageInterface:: |
public | function | Set the phone number of the sender. | 2 |
SmsMessageInterface:: |
public | function | Set the user who created the SMS message. | 2 |