Класс Client

Открытые члены
	__construct ($clientId, $clientSecret, $licenseKey)
	call ($methodName, $additionalParams=null, $licenseCheck=false)
	batch ($actions)
	addApplication (array $applicationSettings)
	updateApplication (array $applicationSettings)
	deleteApplication (array $applicationSettings)
	installApplication (array $applicationSettings)
	unInstallApplication (array $applicationSettings)
	getAuth ($clientId, $scope, array $additionalParams=array())
	checkAuth ($accessToken)
	getCode ($clientId, $state, $additionalParams)
	getApplicationList ()
	sendApplicationUsage (array $usage)
	sendEvent (array $eventItems)

Открытые атрибуты
const	SERVICE_URL = BITRIXREST_URL
const	SERVICE_PATH = "/rest/"
const	METHOD_METHODS = 'methods'
const	METHOD_BATCH = 'batch'
const	METHOD_APPLICATION_ADD = 'application.add'
const	METHOD_APPLICATION_UPDATE = 'application.update'
const	METHOD_APPLICATION_DELETE = 'application.delete'
const	METHOD_APPLICATION_INSTALL = 'application.install'
const	METHOD_APPLICATION_INSTALL_SUBSCRIPTION = 'application.install.subscription'
const	METHOD_APPLICATION_UNINSTALL = 'application.uninstall'
const	METHOD_APPLICATION_STAT = 'application.stat'
const	METHOD_APPLICATION_LIST = 'application.list'
const	METHOD_APPLICATION_USAGE = 'application.usage.add'
const	METHOD_APPLICATION_VERSION_UPDATE = 'application.version.update'
const	METHOD_APPLICATION_VERSION_DELETE = 'application.version.delete'
const	METHOD_REST_AUTHORIZE = 'rest.authorize'
const	METHOD_REST_CHECK = 'rest.check'
const	METHOD_REST_CODE = 'rest.code'
const	METHOD_REST_EVENT_CALL = 'rest.event.call'
const	HTTP_SOCKET_TIMEOUT = 10
const	HTTP_STREAM_TIMEOUT = 10

Защищенные члены
	prepareRequestData ($additionalParams)
	prepareRequest ($additionalParams, $licenseCheck=false)
	prepareResponse ($result)
	getHttpClient ()
	getRequestId (string $methodName)
	getRequestUrl ($methodName)

Защищенные данные
	$clientId
	$clientSecret
	$licenseKey

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

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

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

__construct()

__construct	(		$clientId,
			$clientSecret,
			$licenseKey )

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

Методы

addApplication()

addApplication

(

array

$applicationSettings

)

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

batch()

batch

(

$actions

)

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

call()

call	(		$methodName,
			$additionalParams = null,
			$licenseCheck = false )

Low-level function for REST method call. Returns method response.

Аргументы

string	$methodName	Method name.
array | null	$additionalParams	Method params.
bool | false	$licenseCheck	Send license key in request (will be sent automatically on verification_needed error).

Возвращает

bool|mixed

Исключения

SystemException

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

checkAuth()

checkAuth

(

$accessToken

)

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

deleteApplication()

deleteApplication

(

array

$applicationSettings

)

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

getApplicationList()

getApplicationList

(

)

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

getAuth()

getAuth	(		$clientId,
			$scope,
		array	$additionalParams = array() )

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

getCode()

getCode	(		$clientId,
			$state,
			$additionalParams )

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

getHttpClient()

getHttpClient ( )

protected

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

getRequestId()

getRequestId ( string $methodName )

protected

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

getRequestUrl()

getRequestUrl ( $methodName )

protected

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

installApplication()

installApplication

(

array

$applicationSettings

)

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

prepareRequest()

prepareRequest ( $additionalParams, $licenseCheck = false )

protected

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

prepareRequestData()

prepareRequestData ( $additionalParams )

protected

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

prepareResponse()

prepareResponse ( $result )

protected

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

sendApplicationUsage()

sendApplicationUsage

(

array

$usage

)

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

sendEvent()

sendEvent

(

array

$eventItems

)

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

unInstallApplication()

unInstallApplication

(

array

$applicationSettings

)

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

updateApplication()

updateApplication

(

array

$applicationSettings

)

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

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

$clientId

$clientId

protected

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

$clientSecret

$clientSecret

protected

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

$licenseKey

$licenseKey

protected

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

HTTP_SOCKET_TIMEOUT

const HTTP_SOCKET_TIMEOUT = 10

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

HTTP_STREAM_TIMEOUT

const HTTP_STREAM_TIMEOUT = 10

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

METHOD_APPLICATION_ADD

const METHOD_APPLICATION_ADD = 'application.add'

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

METHOD_APPLICATION_DELETE

const METHOD_APPLICATION_DELETE = 'application.delete'

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

METHOD_APPLICATION_INSTALL

const METHOD_APPLICATION_INSTALL = 'application.install'

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

METHOD_APPLICATION_INSTALL_SUBSCRIPTION

const METHOD_APPLICATION_INSTALL_SUBSCRIPTION = 'application.install.subscription'

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

METHOD_APPLICATION_LIST

const METHOD_APPLICATION_LIST = 'application.list'

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

METHOD_APPLICATION_STAT

const METHOD_APPLICATION_STAT = 'application.stat'

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

METHOD_APPLICATION_UNINSTALL

const METHOD_APPLICATION_UNINSTALL = 'application.uninstall'

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

METHOD_APPLICATION_UPDATE

const METHOD_APPLICATION_UPDATE = 'application.update'

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

METHOD_APPLICATION_USAGE

const METHOD_APPLICATION_USAGE = 'application.usage.add'

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

METHOD_APPLICATION_VERSION_DELETE

const METHOD_APPLICATION_VERSION_DELETE = 'application.version.delete'

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

METHOD_APPLICATION_VERSION_UPDATE

const METHOD_APPLICATION_VERSION_UPDATE = 'application.version.update'

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

METHOD_BATCH

const METHOD_BATCH = 'batch'

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

METHOD_METHODS

const METHOD_METHODS = 'methods'

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

METHOD_REST_AUTHORIZE

const METHOD_REST_AUTHORIZE = 'rest.authorize'

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

METHOD_REST_CHECK

const METHOD_REST_CHECK = 'rest.check'

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

METHOD_REST_CODE

const METHOD_REST_CODE = 'rest.code'

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

METHOD_REST_EVENT_CALL

const METHOD_REST_EVENT_CALL = 'rest.event.call'

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

SERVICE_PATH

const SERVICE_PATH = "/rest/"

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

SERVICE_URL

const SERVICE_URL = BITRIXREST_URL

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