Event extends IRestService
Table of Contents
Constants
- FEATURE_EXTENDED_MODE = 'rest_offline_extended'
Methods
- eventBind() : bool
- /rest/event.bind method handler
- eventGet() : mixed
- eventOfflineClear() : mixed
- eventOfflineError() : mixed
- eventOfflineGet() : mixed
- eventOfflineList() : mixed
- eventsList() : array<string|int, mixed>
- /rest/events method handler
- eventTest() : mixed
- eventUnbind() : array<string|int, mixed>
- /rest/event.unbind method handler
- onRestServiceBuildDescription() : array<string|int, mixed>
- Returns description of events REST API
Constants
FEATURE_EXTENDED_MODE
public
mixed
FEATURE_EXTENDED_MODE
= 'rest_offline_extended'
Methods
eventBind()
/rest/event.bind method handler
public
static eventBind(array<string|int, mixed> $query, mixed $n, CRestServer $server) : bool
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
Parameters
- $query : array<string|int, mixed>
- $n : mixed
- $server : CRestServer
Tags
Return values
booleventGet()
public
static eventGet(mixed $query, mixed $n, CRestServer $server) : mixed
Parameters
- $query : mixed
- $n : mixed
- $server : CRestServer
eventOfflineClear()
public
static eventOfflineClear(mixed $query, mixed $n, CRestServer $server) : mixed
Parameters
- $query : mixed
- $n : mixed
- $server : CRestServer
eventOfflineError()
public
static eventOfflineError(mixed $query, mixed $n, CRestServer $server) : mixed
Parameters
- $query : mixed
- $n : mixed
- $server : CRestServer
eventOfflineGet()
public
static eventOfflineGet(mixed $query, mixed $n, CRestServer $server) : mixed
Parameters
- $query : mixed
- $n : mixed
- $server : CRestServer
eventOfflineList()
public
static eventOfflineList(mixed $query, mixed $n, CRestServer $server) : mixed
Parameters
- $query : mixed
- $n : mixed
- $server : CRestServer
eventsList()
/rest/events method handler
public
static eventsList(array<string|int, mixed> $query, mixed $n, CRestServer $server) : array<string|int, mixed>
Administrator rights required
Query format:
SCOPE - limit events list by some scope FULL - get all events regardless of application scope
Parameters
- $query : array<string|int, mixed>
- $n : mixed
- $server : CRestServer
Tags
Return values
array<string|int, mixed>eventTest()
public
static eventTest(mixed $query, mixed $n, CRestServer $server) : mixed
Parameters
- $query : mixed
- $n : mixed
- $server : CRestServer
eventUnbind()
/rest/event.unbind method handler
public
static eventUnbind(array<string|int, mixed> $query, mixed $n, CRestServer $server) : array<string|int, mixed>
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
Parameters
- $query : array<string|int, mixed>
- $n : mixed
- $server : CRestServer
Tags
Return values
array<string|int, mixed>onRestServiceBuildDescription()
Returns description of events REST API
public
static onRestServiceBuildDescription() : array<string|int, mixed>