factor_sms\local\smsgateway\gateway_interface Interface Reference

Inheritance diagram for factor_sms\local\smsgateway\gateway_interface:

Public Member Functions
	send_sms_message (string $messagecontent, string $phonenumber)
	Sends an SMS message.

Static Public Member Functions
static	add_settings (\admin_settingpage $settings)
	Add gateway specific settings to the SMS factor settings page.
static	is_gateway_enabled ()
	Returns whether or not the gateway is enabled.

Member Function Documentation

add_settings()

static factor_sms\local\smsgateway\gateway_interface::add_settings ( \admin_settingpage $settings )

static

Add gateway specific settings to the SMS factor settings page.

Parameters

admin_settingpage

$settings

Return values

void

Implemented in factor_sms\local\smsgateway\aws_sns.

is_gateway_enabled()

static factor_sms\local\smsgateway\gateway_interface::is_gateway_enabled ( )

static

Returns whether or not the gateway is enabled.

Return values

bool

Implemented in factor_sms\local\smsgateway\aws_sns.

send_sms_message()

factor_sms\local\smsgateway\gateway_interface::send_sms_message	(	string	$messagecontent,
		string	$phonenumber )

Sends an SMS message.

Parameters

string	$messagecontent	the content to send in the SMS message.
string	$phonenumber	the destination for the message.

Return values

bool	true on message send success

Implemented in factor_sms\local\smsgateway\aws_sns.

---

The documentation for this interface was generated from the following file:

• admin/tool/mfa/factor/sms/classes/local/smsgateway/gateway_interface.php