interface SmsMessageInterface in SMS Framework 2.1.x

Interface for SMS message entity.

Hierarchy

• interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\sms\Message\SmsMessageInterface
  • interface \Drupal\sms\Entity\SmsMessageInterface

7 files declare their use of SmsMessageInterface

ActiveHours.php in modules/sms_user/src/ActiveHours.php

ActiveHoursInterface.php in modules/sms_user/src/ActiveHoursInterface.php

DefaultSmsProvider.php in src/Provider/DefaultSmsProvider.php

ScheduleAware.php in tests/modules/sms_test_gateway/src/Plugin/SmsGateway/ScheduleAware.php

SmsFrameworkMessageEntityTest.php in tests/src/Kernel/SmsFrameworkMessageEntityTest.php

... See full list

File

src/Entity/SmsMessageInterface.php, line 14

Namespace

Drupal\sms\Entity

interface SmsMessageInterface extends ContentEntityInterface, PlainSmsMessageInterface {

  /**
   * Gets the entity who sent the SMS message.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity who sent the SMS message, or NULL if it is missing.
   */
  public function getSenderEntity();

  /**
   * Set the entity who sent the SMS message.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity who sent the SMS message.
   *
   * @return $this
   *   Return SMS message for chaining.
   */
  public function setSenderEntity(EntityInterface $entity);

  /**
   * Gets the entity who will receive the SMS message.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity who will receive the SMS message, or NULL if it is missing.
   */
  public function getRecipientEntity();

  /**
   * Set the entity who will receive the SMS message.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity who will receive the SMS message.
   *
   * @return $this
   *   Return SMS message for chaining.
   */
  public function setRecipientEntity(EntityInterface $entity);

  /**
   * Get whether the SMS message is in the queue to be processed.
   *
   * @return bool
   *   Whether the SMS message is in the queue to be processed.
   */
  public function isQueued();

  /**
   * Get whether the SMS message is in the queue to be processed.
   *
   * @param bool $is_queued
   *   Whether the SMS message is in the queue to be processed.
   *
   * @return $this
   *   Return SMS message for chaining.
   */
  public function setQueued($is_queued);

  /**
   * Get the creation timestamp of the SMS message.
   *
   * @return int
   *   Creation timestamp of the SMS message.
   */
  public function getCreatedTime();

  /**
   * Get the time to send the SMS message.
   *
   * @return int
   *   The timestamp after which the SMS message should be sent.
   */
  public function getSendTime();

  /**
   * Set the time to send the SMS message.
   *
   * @param int $send_time
   *   The timestamp after which the SMS message should be sent.
   *
   * @return $this
   *   Return SMS message for chaining.
   */
  public function setSendTime($send_time);

  /**
   * The time the SMS message was processed.
   *
   * This value does not indicate whether the message was sent, only that the
   * gateway accepted the request.
   *
   * @return int|null
   *   The timestamp when SMS message was processed, or NULL if not processed.
   */
  public function getProcessedTime();

  /**
   * Set the time the SMS message was processed.
   *
   * @param int $processed
   *   The timestamp when SMS message was processed.
   *
   * @return $this
   *   Return SMS message for chaining.
   */
  public function setProcessedTime($processed);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
FieldableEntityInterface::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type.	2
FieldableEntityInterface::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle.	2
FieldableEntityInterface::get	public	function	Gets a field item list.	1
FieldableEntityInterface::getFieldDefinition	public	function	Gets the definition of a contained field.	1
FieldableEntityInterface::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields.	1
FieldableEntityInterface::getFields	public	function	Gets an array of all field item lists.	1
FieldableEntityInterface::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields.	1
FieldableEntityInterface::hasField	public	function	Determines whether the entity has a field with the given name.	1
FieldableEntityInterface::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity.	1
FieldableEntityInterface::onChange	public	function	Reacts to changes to a field.	1
FieldableEntityInterface::set	public	function	Sets a field value.	1
FieldableEntityInterface::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity.	1
FieldableEntityInterface::toArray	public	function	Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate	public	function	Validates the currently set values.	1
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
RevisionableInterface::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity.	1
RevisionableInterface::getRevisionId	public	function	Gets the revision identifier of the entity.	1
RevisionableInterface::isDefaultRevision	public	function	Checks if this entity is the default revision.	1
RevisionableInterface::isLatestRevision	public	function	Checks if this entity is the latest revision.	1
RevisionableInterface::isNewRevision	public	function	Determines whether a new revision should be created on save.	1
RevisionableInterface::preSaveRevision	public	function	Acts on a revision before it gets saved.	1
RevisionableInterface::setNewRevision	public	function	Enforces an entity to be saved as a new revision.	1
RevisionableInterface::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID.	1
RevisionableInterface::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved.	1
SmsMessageInterface::addRecipient	public	function	Adds a single recipient to the SMS message.	2
SmsMessageInterface::addRecipients	public	function	Adds multiple recipients to the SMS message.	2
SmsMessageInterface::chunkByRecipients	public	function	Split this SMS message into new messages by chunks of recipients.	2
SmsMessageInterface::getCreatedTime	public	function	Get the creation timestamp of the SMS message.	1
SmsMessageInterface::getDirection	public	function	Get direction of the message.	2
SmsMessageInterface::getGateway	public	function	Get the gateway for this message.	2
SmsMessageInterface::getMessage	public	function	Gets the message to be sent.	2
SmsMessageInterface::getOption	public	function	Gets the option specified by the key $name.	2
SmsMessageInterface::getOptions	public	function	Gets the options for building or sending this SMS message.	2
SmsMessageInterface::getProcessedTime	public	function	The time the SMS message was processed.	1
SmsMessageInterface::getRecipientEntity	public	function	Gets the entity who will receive the SMS message.	1
SmsMessageInterface::getRecipients	public	function	Gets the list of recipients of this SMS message.	2
SmsMessageInterface::getReport	public	function	Gets the delivery report for a particular recipient.	2
SmsMessageInterface::getReports	public	function	Gets the delivery reports for all recipients.	2
SmsMessageInterface::getResult	public	function	Get the result associated with this SMS message.	2
SmsMessageInterface::getSender	public	function	Gets the name of the sender of this SMS message.	2
SmsMessageInterface::getSenderEntity	public	function	Gets the entity who sent the SMS message.	1
SmsMessageInterface::getSenderNumber	public	function	Get phone number of the sender.	2
SmsMessageInterface::getSendTime	public	function	Get the time to send the SMS message.	1
SmsMessageInterface::getUid	public	function	Gets the user who created the SMS message.	2
SmsMessageInterface::getUuid	public	function	Gets the UUID of the SMS object.	2
SmsMessageInterface::isAutomated	public	function	Gets whether this SMS message was generated automatically.	2
SmsMessageInterface::isQueued	public	function	Get whether the SMS message is in the queue to be processed.	1
SmsMessageInterface::removeOption	public	function	Removes an option from this SMS message.	2
SmsMessageInterface::removeRecipient	public	function	Removes a single recipient from the SMS message.	2
SmsMessageInterface::removeRecipients	public	function	Removes multiple recipients from the SMS message.	2
SmsMessageInterface::setAutomated	public	function	Sets whether this SMS message was generated automatically.	2
SmsMessageInterface::setDirection	public	function	Set direction of the message.	2
SmsMessageInterface::setGateway	public	function	Set the gateway for this message.	2
SmsMessageInterface::setMessage	public	function	Set the message to be sent.	2
SmsMessageInterface::setOption	public	function	Sets an option for this SMS message.	2
SmsMessageInterface::setProcessedTime	public	function	Set the time the SMS message was processed.	1
SmsMessageInterface::setQueued	public	function	Get whether the SMS message is in the queue to be processed.	1
SmsMessageInterface::setRecipientEntity	public	function	Set the entity who will receive the SMS message.	1
SmsMessageInterface::setResult	public	function	Set the result associated with this SMS message.	2
SmsMessageInterface::setSender	public	function	Set the name of the sender of this SMS message.	2
SmsMessageInterface::setSenderEntity	public	function	Set the entity who sent the SMS message.	1
SmsMessageInterface::setSenderNumber	public	function	Set the phone number of the sender.	2
SmsMessageInterface::setSendTime	public	function	Set the time to send the SMS message.	1
SmsMessageInterface::setUid	public	function	Set the user who created the SMS message.	2
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
TranslatableInterface::addTranslation	public	function	Adds a new translation to the translatable object.	1
TranslatableInterface::getTranslation	public	function	Gets a translation of the data.	1
TranslatableInterface::getTranslationLanguages	public	function	Returns the languages the data is translated to.	1
TranslatableInterface::getUntranslated	public	function	Returns the translatable object referring to the original language.	1
TranslatableInterface::hasTranslation	public	function	Checks there is a translation for the given language code.	1
TranslatableInterface::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes.	1
TranslatableInterface::isDefaultTranslation	public	function	Checks whether the translation is the default one.	1
TranslatableInterface::isNewTranslation	public	function	Checks whether the translation is new.	1
TranslatableInterface::isTranslatable	public	function	Returns the translation support status.	1
TranslatableInterface::removeTranslation	public	function	Removes the translation identified by the given language code.	1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation.	1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation.	1
TranslatableRevisionableInterface::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision.	1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced.	1
TranslatableRevisionableInterface::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected.	1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value.	1