Класс ExternalSender

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

Открытые члены
	__construct (?string $apiKey, string $apiEndpoint, int $socketTimeout=10, int $streamTimeout=30)
	callExternalMethod (string $method, ?array $requestParams=null, string $httpMethod='')
Открытые члены унаследованные от ExternalSender
	setApiKey (string $apiKey)

Защищенные члены
	parseExternalResponse (string $httpResult)
	checkResponse (array $response)
	convertRequestParams (array $requestParams)
	getErrorMessageByCode (?string $errorCode)

Дополнительные унаследованные члены
Защищенные данные унаследованные от ExternalSender
const	USER_AGENT = 'Bitrix24'
const	CONTENT_TYPE = 'application/json'
const	CHARSET = 'UTF-8'
const	WAIT_RESPONSE = true
string	$apiKey
string	$apiEndpoint
int	$socketTimeout
int	$streamTimeout

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

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

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

__construct()

__construct	(	?string	$apiKey,
		string	$apiEndpoint,
		int	$socketTimeout = 10,
		int	$streamTimeout = 30 )

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

Методы

callExternalMethod()

callExternalMethod	(	string	$method,
		?array	$requestParams = null,
		string	$httpMethod = '' )

Аргументы

string	$method
array | null	$requestParams
string	$httpMethod	see class constants \Bitrix\Main\Web\HttpClient

Возвращает

HttpRequestResult

Замещает ExternalSender.

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

checkResponse()

checkResponse ( array $response )

protected

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

convertRequestParams()

convertRequestParams ( array $requestParams )

protected

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

getErrorMessageByCode()

getErrorMessageByCode ( ?string $errorCode )

protected

Mapping from the docs https://edna.docs.apiary.io/#reference/0

Аргументы

string

$errorCode

Возвращает

string

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

parseExternalResponse()

parseExternalResponse ( string $httpResult )

protected

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