Класс SmsEdnaru

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

Открытые члены
	__construct ()
	getId ()
	getName ()
	getShortName ()
	getType ()
	getManageUrl ()
	getExternalId ()
	isRegistered ()
	register (array $fields)
	getOwnerInfo ()
	getExternalManageUrl ()
	getCallbackUrl ()
	isConfirmed ()
	confirmRegistration (array $fields)
	sendConfirmationCode ()
	getFromList ()
	refreshFromList ()
	isCorrectFrom ($from)
	getDefaultFrom ()
	getFirstFromList ()
	getMessageStatus (array $messageFields)
	sendMessage (array $messageFields)
	prepareMessageBodyForSave (string $text)
	getMessageTemplates (string $subject='')
	getSentTemplateMessage (string $from, string $to)
	setSocketTimeout (int $socketTimeout)
	setStreamTimeout (int $streamTimeout)
	getRegistrationUrl ()
	isMigratedToNewAPI ()
	migrateToNewApi ()
	setNewApi (bool $mode)
	addRefreshFromListAgent ()
Открытые члены унаследованные от BaseConfigurable
	isConfigurable ()
	isDemo ()
	setDefaultFrom ($from)
	canUse ()
	enableDemo ()
	disableDemo ()
	sync ()
	clearOptions ()
	getConfigComponentTemplatePageName ()
	isTemplatesBased ()
	getTemplatesList (array $context=null)
	prepareTemplate ($templateData)

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

Открытые атрибуты
const	ID = 'smsednaru'

Защищенные данные
Edna EdnaRu	$utils
Защищенные данные унаследованные от BaseConfigurable
	$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

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

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

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

Конструктор(ы)

__construct()

__construct

(

)

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

Методы

addRefreshFromListAgent()

addRefreshFromListAgent

(

)

Adds agent for execution.

Возвращает

void

См. также

refreshFromListAgent

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

confirmRegistration()

confirmRegistration

(

array

$fields

)

Аргументы

array

$fields

Возвращает

Result

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

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

getCallbackUrl()

getCallbackUrl

(

)

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

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

getDefaultFrom()

getDefaultFrom

(

)

Get default From.

Возвращает

null|string

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

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

getExternalId()

getExternalId

(

)

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

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

getExternalManageUrl()

getExternalManageUrl

(

)

Возвращает

string

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

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

getFirstFromList()

getFirstFromList

(

)

Возвращает

mixed|null

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

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

getFromList()

getFromList

(

)

Возвращает

array<array{id: int, name: string, channelPhone: string}>

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

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

getId()

getId

(

)

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

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

getManageUrl()

getManageUrl

(

)

Возвращает

string

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

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

getMessageStatus()

getMessageStatus

(

array

$messageFields

)

Аргументы

array

$messageFields

Возвращает

MessageStatus Message status result.

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

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

getMessageTemplates()

getMessageTemplates

(

string

$subject = ''

)

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

getName()

getName

(

)

Возвращает

string

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

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

getOwnerInfo()

getOwnerInfo

(

)

Возвращает

array

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

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

getRegistrationUrl()

getRegistrationUrl

(

)

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

getSentTemplateMessage()

getSentTemplateMessage	(	string	$from,
		string	$to )

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

getShortName()

getShortName

(

)

Возвращает

string

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

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

getType()

getType

(

)

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

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

isConfirmed()

isConfirmed

(

)

Check is registration confirmed.

Возвращает

bool

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

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

isCorrectFrom()

isCorrectFrom

(

$from

)

Аргументы

string

$from

Возвращает

bool

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

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

isMigratedToNewAPI()

isMigratedToNewAPI

(

)

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

isRegistered()

isRegistered

(

)

Check registration state.

Возвращает

bool

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

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

migrateToNewApi()

migrateToNewApi

(

)

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

prepareMessageBodyForSave()

prepareMessageBodyForSave

(

string

$text

)

Prepares text for message body.

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

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

refreshFromList()

refreshFromList

(

)

The agent's goal is regular refreshing FromList.

Возвращает

void

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

refreshFromListAgent()

static refreshFromListAgent ( )

static

The agent's goal is regular refreshing FromList cache.

Возвращает

string

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

register()

register

(

array

$fields

)

Аргументы

array

$fields

Возвращает

Result

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

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

resolveStatus()

static resolveStatus ( $serviceStatus )

static

Converts service status to internal status

См. также

\Bitrix\MessageService\MessageStatus

Аргументы

mixed

$serviceStatus

Возвращает

int

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

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

sendConfirmationCode()

sendConfirmationCode

(

)

Возвращает

Result

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

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

sendMessage()

sendMessage

(

array

$messageFieldsFields

)

Аргументы

array

$messageFieldsFields

Возвращает

Result\SendMessage Send operation result.

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

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

setNewApi()

setNewApi

(

bool

$mode

)

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

setSocketTimeout()

setSocketTimeout

(

int

$socketTimeout

)

Аргументы

int

$socketTimeout

Возвращает

Base

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

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

setStreamTimeout()

setStreamTimeout

(

int

$streamTimeout

)

Аргументы

int

$streamTimeout

Возвращает

Base

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

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

Данные класса

$utils

Edna EdnaRu $utils

protected

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

ID

const ID = 'smsednaru'

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