public function SmsGatewayPluginBase::getCreditsBalance in SMS Framework 2.1.x

Same name and namespace in other branches

1. 8 src/Plugin/SmsGatewayPluginBase.php \Drupal\sms\Plugin\SmsGatewayPluginBase::getCreditsBalance()
2. 2.x src/Plugin/SmsGatewayPluginBase.php \Drupal\sms\Plugin\SmsGatewayPluginBase::getCreditsBalance()

Returns the credit balance available on this gateway.

The 'credit_balance_available' plugin annotation should be set to inform the framework whether this gateway supports balance queries.

Return value

float|null The credit balance of the gateway, or NULL if unknown.

Overrides SmsGatewayPluginInterface::getCreditsBalance

1 method overrides SmsGatewayPluginBase::getCreditsBalance()

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

Returns the credit balance available on this gateway.

File

src/Plugin/SmsGatewayPluginBase.php, line 83

Class

SmsGatewayPluginBase

Base class for sms gateway plugins.

Namespace

Drupal\sms\Plugin

Code

public function getCreditsBalance() {
  return NULL;
}