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

Same name and namespace in other branches

1. 8 src/Plugin/SmsGatewayPluginInterface.php \Drupal\sms\Plugin\SmsGatewayPluginInterface::getCreditsBalance()
2. 2.x src/Plugin/SmsGatewayPluginInterface.php \Drupal\sms\Plugin\SmsGatewayPluginInterface::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.

1 method overrides SmsGatewayPluginInterface::getCreditsBalance()

SmsGatewayPluginBase::getCreditsBalance in src/Plugin/SmsGatewayPluginBase.php

Returns the credit balance available on this gateway.

File

src/Plugin/SmsGatewayPluginInterface.php, line 40

Class

SmsGatewayPluginInterface

Default implementation of SMS gateway plugin.

Namespace

Drupal\sms\Plugin

Code

public function getCreditsBalance();