1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс Event
Граф наследования:Event:
IRestService

Открытые статические члены

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'
Поля данных унаследованные от IRestService
const LIST_LIMIT = 50

Защищенные статические члены

static sanitizeFilter ($filter, array $availableFields=null, $valueCallback=null, array $availableOperations=null)
static sanitizeOrder ($order, array $availableFields=null)
static isExtendedModeEnabled ()
Защищенные статические члены унаследованные от IRestService
static getNavData ($start, $bORM=false)
static setNavData ($result, $dbRes)

Дополнительные унаследованные члены

Открытые члены унаследованные от IRestService
 getDescription ()

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

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

Методы

◆ eventBind()

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 строка 154

◆ eventGet()

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

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

◆ eventOfflineClear()

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

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

◆ eventOfflineError()

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

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

◆ eventsList()

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 строка 86

◆ eventTest()

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

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

◆ eventUnbind()

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 строка 342

◆ isExtendedModeEnabled()

isExtendedModeEnabled ( )
staticprotected

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

◆ onRestServiceBuildDescription()

onRestServiceBuildDescription ( )
static

Returns description of events REST API

Возвращает
array

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

◆ sanitizeFilter()

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

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

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

◆ sanitizeOrder()

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

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

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

Поля

◆ FEATURE_EXTENDED_MODE

const FEATURE_EXTENDED_MODE = 'rest_offline_extended'

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

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