class SmsGateway in SMS Framework 8

Defines SmsGateway Annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\sms\Annotation\SmsGateway

8 classes are annotated with SmsGateway

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

A gateway for testing undefined capability annotation values.

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

Defines a gateway supporting incoming route.

LogGateway in src/Plugin/SmsGateway/LogGateway.php

Defines a logger gateway for testing and debugging.

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

Defines a gateway storing transmitted SMS in memory.

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

Defines a gateway requiring chunked messages.

... See full list

File

src/Annotation/SmsGateway.php, line 14

Namespace

Drupal\sms\Annotation

class SmsGateway extends Plugin {

  /**
   * The machine name of the sms gateway.
   *
   * @var string
   */
  protected $id;

  /**
   * Translated user-readable label.
   *
   * @var string
   */
  protected $label;

  /**
   * Maximum number of recipients per outgoing message.
   *
   * Use -1 for no limit.
   *
   * @var int
   */
  protected $outgoing_message_max_recipients;

  /**
   * Whether the gateway supports receiving messages.
   *
   * @var bool
   */
  protected $incoming;

  /**
   * Whether to automatically create a route for receiving incoming messages.
   *
   * @var bool
   */
  protected $incoming_route;

  /**
   * Whether the gateway is capable of delaying messages until a date.
   *
   * Schedule aware gateways must extract sending time from all message
   * getSendTime() method. Keep in mind this method is only available if the
   * message is a SMS message entity. See the schedule aware gateway
   * implementation in the test modules for an example.
   *
   * @var bool
   */
  protected $schedule_aware;

  /**
   * Whether the gateway can pull reports.
   *
   * @var bool
   * @see \Drupal\sms\Entity\SmsGatewayInterface::supportsReportsPull()
   */
  protected $reports_pull;

  /**
   * Whether the gateway can handle reports pushed to the site.
   *
   * @var bool
   * @see \Drupal\sms\Entity\SmsGatewayInterface::supportsReportsPush()
   */
  protected $reports_push;

  /**
   * Whether the gateway supports queries of current credit balance.
   *
   * @var bool
   * @see \Drupal\sms\Entity\SmsGatewayInterface::supportsCreditBalanceQuery()
   */
  protected $credit_balance_available;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
SmsGateway::$credit_balance_available	protected	property	Whether the gateway supports queries of current credit balance.
SmsGateway::$id	protected	property	The machine name of the sms gateway.
SmsGateway::$incoming	protected	property	Whether the gateway supports receiving messages.
SmsGateway::$incoming_route	protected	property	Whether to automatically create a route for receiving incoming messages.
SmsGateway::$label	protected	property	Translated user-readable label.
SmsGateway::$outgoing_message_max_recipients	protected	property	Maximum number of recipients per outgoing message.
SmsGateway::$reports_pull	protected	property	Whether the gateway can pull reports.
SmsGateway::$reports_push	protected	property	Whether the gateway can handle reports pushed to the site.
SmsGateway::$schedule_aware	protected	property	Whether the gateway is capable of delaying messages until a date.