Класс Base

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

Открытые члены
	setSocketTimeout (int $socketTimeout)
	setStreamTimeout (int $streamTimeout)
	isConfigurable ()
	getType ()
	getId ()
	getExternalId ()
	getName ()
	getShortName ()
	canUse ()
	getFromList ()
	getDefaultFrom ()
	getFirstFromList ()
	isCorrectFrom ($from)
	sendMessage (array $messageFieldsFields)
	getManageUrl ()
	prepareMessageBodyForSave (string $text)
	sendTemplate (string $name, string $text, array $examples=[], ?string $langCode=null)

Открытые статические члены
static	isSupported ()
static	className ()
static	resolveStatus ($serviceStatus)

Защищенные члены
	prepareMessageBodyForSend (string $text)

Защищенные данные
Providers Informant	$informant
Providers Initiator	$initiator
Providers Sender	$sender
int	$socketTimeout = 10
int	$streamTimeout = 30

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

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

Методы

canUse()

canUse ( )

abstract

Check can use state of provider.

Возвращает

bool

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

className()

className ( )

static

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

getDefaultFrom()

getDefaultFrom

(

)

Get default From.

Возвращает

null|string

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

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

getExternalId()

getExternalId

(

)

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

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

getFirstFromList()

getFirstFromList

(

)

Возвращает

mixed|null

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

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

getFromList()

getFromList ( )

abstract

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

getId()

getId ( )

abstract

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

getManageUrl()

getManageUrl

(

)

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

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

getName()

getName ( )

abstract

Возвращает

string

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

getShortName()

getShortName ( )

abstract

Возвращает

string

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

getType()

getType

(

)

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

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

isConfigurable()

isConfigurable

(

)

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

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

isCorrectFrom()

isCorrectFrom

(

$from

)

Аргументы

string

$from

Возвращает

bool

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

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

isSupported()

isSupported ( )

static

Возвращает

bool

Переопределяется в Ednaru, EdnaruImHpx, ISmsCenter, MfmsRu, Rest, SmscUa, SmsLineBy и Twilio2.

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

prepareMessageBodyForSave()

prepareMessageBodyForSave

(

string

$text

)

Prepares text for message body.

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

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

prepareMessageBodyForSend()

prepareMessageBodyForSend ( string $text )

protected

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

resolveStatus()

resolveStatus ( $serviceStatus )

static

Converts service status to internal status

См. также

\Bitrix\MessageService\MessageStatus

Аргументы

mixed

$serviceStatus

Возвращает

int

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

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

sendMessage()

sendMessage ( array $messageFieldsFields )

abstract

Аргументы

array

$messageFieldsFields

Возвращает

Result\SendMessage Send operation result.

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

sendTemplate()

sendTemplate	(	string	$name,
		string	$text,
		array	$examples = [],
		?string	$langCode = null )

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

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

setSocketTimeout()

setSocketTimeout

(

int

$socketTimeout

)

Аргументы

int

$socketTimeout

Возвращает

Base

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

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

setStreamTimeout()

setStreamTimeout

(

int

$streamTimeout

)

Аргументы

int

$streamTimeout

Возвращает

Base

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

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

Поля

$informant

Providers Informant $informant

protected

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

$initiator

Providers Initiator $initiator

protected

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

$sender

Providers Sender $sender

protected

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

$socketTimeout

int $socketTimeout = 10

protected

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

$streamTimeout

int $streamTimeout = 30

protected

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

---

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

• C:/bitrix/modules/messageservice/lib/sender/base.php