Класс Event

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

Открытые статические члены
static	onRestServiceBuildDescription ()
static	eventsList ($query, $n, \CRestServer $server)
static	eventBind ($query, $n, \CRestServer $server)
static	eventUnbind ($query, $n, \CRestServer $server)
static	eventGet ($query, $n, \CRestServer $server)
static	eventTest ($query, $n, \CRestServer $server)
static	eventOfflineClear ($query, $n, \CRestServer $server)
static	eventOfflineError ($query, $n, \CRestServer $server)

Открытые атрибуты
const	FEATURE_EXTENDED_MODE = 'rest_offline_extended'

Защищенные статические члены
static	sanitizeFilter ($filter, array $availableFields=null, $valueCallback=null, array $availableOperations=null)
static	sanitizeOrder ($order, array $availableFields=null)
static	isExtendedModeEnabled ()

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

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

Методы

eventBind()

static eventBind ( $query, $n, \CRestServer $server )

static

/rest/event.bind method handler

Administrator rights required

Query format:

• EVENT - event name
• EVENT_TYPE = {online|offline} - type of event handling. Default: online
• AUTH_TYPE - User ID, whose auth will be generated for handler. Useless for offline type. Default value is 0, which means getting auth for user, authorized when event is called
• HANDLER - URL of event handler. Useless for offline type

Аргументы

array	$query
	$n
\CRestServer	$server

Возвращает

bool

Исключения

AccessException
ArgumentException
ArgumentNullException
AuthTypeException
RestException

Exception

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

eventGet()

static eventGet ( $query, $n, \CRestServer $server )

static

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

eventOfflineClear()

static eventOfflineClear ( $query, $n, \CRestServer $server )

static

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

eventOfflineError()

static eventOfflineError ( $query, $n, \CRestServer $server )

static

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

eventsList()

static eventsList ( $query, $n, \CRestServer $server )

static

/rest/events method handler

Administrator rights required

Query format:

SCOPE - limit events list by some scope FULL - get all events regardless of application scope

Аргументы

array	$query
	$n
\CRestServer	$server

Возвращает

array

Исключения

AuthTypeException

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

eventTest()

static eventTest ( $query, $n, \CRestServer $server )

static

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

eventUnbind()

static eventUnbind ( $query, $n, \CRestServer $server )

static

/rest/event.unbind method handler

Returns count of unbinded events

Administrator rights required

Query format:

• EVENT - event name
• EVENT_TYPE = {online|offline} - type of event handling. Default: online
• AUTH_TYPE - The same value as event.bind was called with. Useless for offline type. Default 0
• HANDLER - URL of event handler. Useless for offline type

Аргументы

array	$query
	$n
\CRestServer	$server

Возвращает

array

Исключения

AccessException
ArgumentException
ArgumentNullException
AuthTypeException

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

Исключения

Exception

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

isExtendedModeEnabled()

static isExtendedModeEnabled ( )

staticprotected

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

onRestServiceBuildDescription()

static onRestServiceBuildDescription ( )

static

Returns description of events REST API

Возвращает

array

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

sanitizeFilter()

static sanitizeFilter ( $filter, array $availableFields = null, $valueCallback = null, array $availableOperations = null )

staticprotected

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

sanitizeOrder()

static sanitizeOrder ( $order, array $availableFields = null )

staticprotected

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

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

FEATURE_EXTENDED_MODE

const FEATURE_EXTENDED_MODE = 'rest_offline_extended'

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