Граф наследования:BaseConfigurable:

Открытые члены
	isConfigurable ()
	isDemo ()
	isRegistered ()
	isConfirmed ()
	setDefaultFrom ($from)
	canUse ()
	register (array $fields)
	getOwnerInfo ()
	confirmRegistration (array $fields)
	sendConfirmationCode ()
	getManageUrl ()
	getExternalManageUrl ()
	getMessageStatus (array $messageFields)
	enableDemo ()
	disableDemo ()
	sync ()
	clearOptions ()
	getConfigComponentTemplatePageName ()
	isTemplatesBased ()
	getTemplatesList (array $context=null)
	prepareTemplate ($templateData)
Открытые члены унаследованные от Base
	setSocketTimeout (int $socketTimeout)
	setStreamTimeout (int $streamTimeout)
	getType ()
	getId ()
	getExternalId ()
	getName ()
	getShortName ()
	getFromList ()
	getDefaultFrom ()
	getFirstFromList ()
	isCorrectFrom ($from)
	sendMessage (array $messageFieldsFields)
	prepareMessageBodyForSave (string $text)
	sendTemplate (string $name, string $text, array $examples=[], ?string $langCode=null)

Защищенные члены
	getCallbackUrl ()
	setOptions (array $options)
	getOptions ()
	setOption ($optionName, $optionValue)
	getOption ($optionName, $defaultValue=null)
Защищенные члены унаследованные от Base
	prepareMessageBodyForSend (string $text)

Защищенные данные
	$options
Providers DemoManager	$demoManager
Providers Registrar	$registrar
Providers OptionManager	$optionManager
Providers TemplateManager	$templateManager
Защищенные данные унаследованные от Base
Providers Informant	$informant
Providers Initiator	$initiator
Providers Sender	$sender
int	$socketTimeout = 10
int	$streamTimeout = 30

Дополнительные унаследованные члены
Открытые статические члены унаследованные от Base
static	isSupported ()
static	className ()
static	resolveStatus ($serviceStatus)

Подробное описание

См. определение в файле baseconfigurable.php строка 11

Методы

◆ canUse()

canUse ( )

Check can use state of sender.

Возвращает: bool

Переопределяет метод предка Base.

Переопределяется в DummyHttp, EdnaruImHpx и Twilio.

См. определение в файле baseconfigurable.php строка 63

◆ clearOptions()

clearOptions ( )

Возвращает: bool

См. определение в файле baseconfigurable.php строка 247

◆ confirmRegistration()

confirmRegistration ( array $fields )

Аргументы

array $fields

Возвращает: Result

Переопределяется в SmsEdnaru и SmsRu.

См. определение в файле baseconfigurable.php строка 83

◆ disableDemo()

disableDemo ( )

Disable demo mode.

Возвращает: $this

См. определение в файле baseconfigurable.php строка 135

◆ enableDemo()

enableDemo ( )

Enable demo mode.

Возвращает: $this

См. определение в файле baseconfigurable.php строка 125

◆ getCallbackUrl()

getCallbackUrl ( )

protected

Переопределяется в Ednaru, EdnaruImHpx, SmsEdnaru и Twilio2.

См. определение в файле baseconfigurable.php строка 150

◆ getConfigComponentTemplatePageName()

getConfigComponentTemplatePageName ( )

Переопределяется в Twilio2.

См. определение в файле baseconfigurable.php строка 255

◆ getExternalManageUrl()

getExternalManageUrl ( )

abstract

Возвращает: string

Переопределяется в DummyHttp, Ednaru, EdnaruImHpx, ISmsCenter, MfmsRu, SmsAssistentBy, SmscUa, SmsEdnaru, SmsLineBy, SmsRu и Twilio.

◆ getManageUrl()

getManageUrl ( )

Возвращает: string

Переопределяет метод предка Base.

Переопределяется в Ednaru и SmsEdnaru.

См. определение в файле baseconfigurable.php строка 99

◆ getMessageStatus()

getMessageStatus ( array $messageFields )

abstract

Аргументы

array $messageFields

Возвращает: MessageStatus Message status result.

Переопределяется в DummyHttp, Ednaru, EdnaruImHpx, ISmsCenter, MfmsRu, SmsAssistentBy, SmscUa, SmsEdnaru, SmsLineBy, SmsRu и Twilio.

◆ getOption()

getOption	(		$optionName,
			$defaultValue = null )

protected

Аргументы

	$optionName
mixed	$defaultValue

Возвращает: mixed|null

См. определение в файле baseconfigurable.php строка 237

◆ getOptions()

getOptions ( )

protected

Возвращает: array

См. определение в файле baseconfigurable.php строка 211

◆ getOwnerInfo()

getOwnerInfo ( )

abstract

Возвращает: array

Переопределяется в DummyHttp, Ednaru, EdnaruImHpx, ISmsCenter, MfmsRu, SmsAssistentBy, SmscUa, SmsEdnaru, SmsLineBy, SmsRu и Twilio.

◆ getTemplatesList()

getTemplatesList ( array $context = null )

List of available templates for templates-based senders Should return array of templates like this:

[ ['ID' => '1', 'TITLE' => 'Template 1', 'PREVIEW' => 'Message created from template 1'], ['ID' => '2', 'TITLE' => 'Template 2', 'PREVIEW' => 'Message created from template 2'], ]

Аргументы

array | null $context Context for context-dependant templates

Возвращает: array

Переопределяется в Ednaru.

См. определение в файле baseconfigurable.php строка 283

◆ isConfigurable()

isConfigurable ( )

Переопределяет метод предка Base.

См. определение в файле baseconfigurable.php строка 20

◆ isConfirmed()

isConfirmed ( )

Check is registration confirmed.

Возвращает: bool

Переопределяется в SmsEdnaru и SmsRu.

См. определение в файле baseconfigurable.php строка 44

◆ isDemo()

isDemo ( )

Check demo status.

Возвращает: bool

Переопределяется в SmsRu и Twilio.

См. определение в файле baseconfigurable.php строка 29

◆ isRegistered()

isRegistered ( )

abstract

Check registration state.

Возвращает: bool

Переопределяется в DummyHttp, Ednaru, EdnaruImHpx, ISmsCenter, MfmsRu, SmsAssistentBy, SmscUa, SmsEdnaru, SmsLineBy, SmsRu и Twilio.

◆ isTemplatesBased()

isTemplatesBased ( )

Can message be created from template only

Возвращает: bool

Переопределяется в Ednaru.

См. определение в файле baseconfigurable.php строка 265

◆ prepareTemplate()

prepareTemplate ( $templateData )

Prepare template for save in message headers

Переопределяется в Ednaru.

См. определение в файле baseconfigurable.php строка 291

◆ register()

register ( array $fields )

abstract

Аргументы

array $fields

Возвращает: Result

Переопределяется в DummyHttp, Ednaru, EdnaruImHpx, ISmsCenter, MfmsRu, SmsAssistentBy, SmscUa, SmsEdnaru, SmsLineBy, SmsRu и Twilio.

◆ sendConfirmationCode()

sendConfirmationCode ( )

Возвращает: Result

Переопределяется в SmsEdnaru и SmsRu.

См. определение в файле baseconfigurable.php строка 91

◆ setDefaultFrom()

setDefaultFrom ( $from )

Set default From.

Аргументы

string $from From.

Возвращает: $this

См. определение в файле baseconfigurable.php строка 54

◆ setOption()

setOption	(		$optionName,
			$optionValue )

protected

Аргументы

$optionName
$optionValue

Возвращает: $this

См. определение в файле baseconfigurable.php строка 224

◆ setOptions()

setOptions ( array $options )

protected

Аргументы

array $options

Возвращает: $this

Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле baseconfigurable.php строка 199

◆ sync()

sync ( )

Sync remote state (load From list etc.)

Возвращает: $this

Переопределяется в SmsAssistentBy, SmscUa, SmsLineBy, SmsRu и Twilio.

См. определение в файле baseconfigurable.php строка 145

Поля

◆ $demoManager

Providers DemoManager $demoManager

protected

См. определение в файле baseconfigurable.php строка 15

◆ $optionManager

Providers OptionManager $optionManager

protected

См. определение в файле baseconfigurable.php строка 17

◆ $options

$options

protected

См. определение в файле baseconfigurable.php строка 13

◆ $registrar

Providers Registrar $registrar

protected

См. определение в файле baseconfigurable.php строка 16

◆ $templateManager

Providers TemplateManager $templateManager

protected

См. определение в файле baseconfigurable.php строка 18

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/messageservice/lib/sender/baseconfigurable.php

Открытые члены

Защищенные члены

Защищенные данные

Дополнительные унаследованные члены

Подробное описание

Методы

◆ canUse()

◆ clearOptions()

◆ confirmRegistration()

◆ disableDemo()

◆ enableDemo()

◆ getCallbackUrl()

◆ getConfigComponentTemplatePageName()

◆ getExternalManageUrl()

◆ getManageUrl()

◆ getMessageStatus()

◆ getOption()

◆ getOptions()

◆ getOwnerInfo()

◆ getTemplatesList()

◆ isConfigurable()

◆ isConfirmed()

◆ isDemo()

◆ isRegistered()

◆ isTemplatesBased()

◆ prepareTemplate()

◆ register()

◆ sendConfirmationCode()

◆ setDefaultFrom()

◆ setOption()

◆ setOptions()

◆ sync()

Поля

◆ $demoManager

◆ $optionManager

◆ $options

◆ $registrar

◆ $templateManager