PHP Class Bitrix24\Event\Event

Inheritance: extends Bitrix24\Bitrix24Entity
Show file Open project: mesilov/bitrix24-php-sdk

Public Methods

Method Description
bind ( $eventName, $handler, $authType = null ) : array Register new event handler. Work only for user with portal administrator rights
get ( ) : array Get list of register events
getList ( ) : array Get list of all supported events
unbind ( $eventName = NULL, $handler = NULL, null $authType = null ) : array Unregister event handler. Work only for user with portal administrator rights

Protected Methods

Method Description
isEventHandlerCodeValid ( $eventHandlerName ) : boolean check is event handler code valid

Method Details

bind() public method

Register new event handler. Work only for user with portal administrator rights
See link: http://dev.1c-bitrix.ru/rest_help/general/event_bind.php
public bind ( $eventName, $handler, $authType = null ) : array
$eventName string event handler code
$handler string event handler URL
$authType integer user identifier, under witch event handler was executed
return array

get() public method

Get list of register events
public get ( ) : array
return array

getList() public method

Get list of all supported events
See link: http://dev.1c-bitrix.ru/rest_help/general/events.php
public getList ( ) : array
return array

isEventHandlerCodeValid() protected method

check is event handler code valid
protected isEventHandlerCodeValid ( $eventHandlerName ) : boolean
$eventHandlerName
return boolean

unbind() public method

Unregister event handler. Work only for user with portal administrator rights
See link: http://dev.1c-bitrix.ru/rest_help/general/event_unbind.php
public unbind ( $eventName = NULL, $handler = NULL, null $authType = null ) : array
$eventName
$handler
$authType null
return array