Класс Rest

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

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

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

Поля данных
const	ID = 'rest'

Статические открытые данные
static	$langFields

Дополнительные унаследованные члены
Защищенные члены унаследованные от Base
	prepareMessageBodyForSend (string $text)
Защищенные данные унаследованные от Base
Providers Informant	$informant
Providers Initiator	$initiator
Providers Sender	$sender
int	$socketTimeout = 10
int	$streamTimeout = 30

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

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

Методы

canUse()

canUse

(

)

Check can use state of provider.

Возвращает

bool

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

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

getFromList()

getFromList

(

)

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

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

getId()

getId

(

)

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

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

getName()

getName

(

)

Возвращает

string

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

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

getShortName()

getShortName

(

)

Возвращает

string

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

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

isCorrectFrom()

isCorrectFrom

(

$from

)

Аргументы

string

$from

Возвращает

bool

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

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

isSupported()

isSupported ( )

static

Возвращает

bool

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

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

resolveStatus()

resolveStatus ( $serviceStatus )

static

Converts service status to internal status

См. также

\Bitrix\MessageService\MessageStatus

Аргументы

mixed

$serviceStatus

Возвращает

int

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

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

sendMessage()

sendMessage

(

array

$messageFieldsFields

)

Аргументы

array

$messageFieldsFields

Возвращает

Result\SendMessage Send operation result.

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

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

Поля

$langFields

$langFields

static

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

ID

const ID = 'rest'

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

---

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

• C:/bitrix/modules/messageservice/lib/sender/sms/rest.php