Класс Sender

Открытые статические члены
static	parseEventName ($name)
static	bind ($moduleId, $eventName)
static	unbind ($moduleId, $eventName)
static	getDefaultEventParams ()
static	getAuth ($appId, $userId, array $additionalData=array(), array $additional=array())
static	call ($handlersList)
static	send ()
static	getProvider ()
static	setProvider (ProviderInterface $provider)
static	getProviderOffline ()
static	setProviderOffline (ProviderOfflineInterface $providerOffline)

Защищенные статические члены
static	getDefaultProvider ()
static	getDefaultProviderOffline ()
static	initialize ()
static	getHandlerName ($moduleId, $eventName)

Статические защищенные данные
static	$initialized = false
static	$forkSet = false
static	$queryData = array()
static	$provider
static	$providerOffline
static	$defaultEventParams

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

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

Методы

bind()

static bind ( $moduleId, $eventName )

static

Binds REST event handler on PHP event.

Аргументы

string	$moduleId	Event owner module.
string	$eventName	Event name.

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

call()

static call ( $handlersList )

static

Calls or schedules the query to SQS.

Аргументы

array

$handlersList

Event handlers to call.

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

getAuth()

static getAuth ( $appId, $userId, array $additionalData = array(), array $additional = array() )

static

Returns authorization array for event handlers and BP activities.

Аргументы

string | int	$appId	Application ID or CODE.
int	$userId	User ID which will be the owner of access_token.
array	$additionalData	Additional data which will be stored with access_token.
array	$additional	Event parameters. Keys sendAuth and sendRefreshToken supported.

Возвращает

array|bool|null

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

getDefaultEventParams()

static getDefaultEventParams ( )

static

Getter for default event params array.

Возвращает

array

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

getDefaultProvider()

static getDefaultProvider ( )

staticprotected

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

getDefaultProviderOffline()

static getDefaultProviderOffline ( )

staticprotected

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

getHandlerName()

static getHandlerName ( $moduleId, $eventName )

staticprotected

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

getProvider()

static getProvider ( )

static

Возвращает

ProviderInterface

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

getProviderOffline()

static getProviderOffline ( )

static

Возвращает

ProviderOfflineInterface

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

initialize()

static initialize ( )

staticprotected

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

parseEventName()

static parseEventName ( $name )

static

Utility function to parse pseudo-method name

Аргументы

string

$name

Pseudo-method name.

Возвращает

array

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

send()

static send ( )

static

Sends all scheduled handlers to SQS.

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

setProvider()

static setProvider ( ProviderInterface $provider )

static

Аргументы

ProviderInterface

$provider

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

setProviderOffline()

static setProviderOffline ( ProviderOfflineInterface $providerOffline )

static

Аргументы

ProviderOfflineInterface

$providerOffline

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

unbind()

static unbind ( $moduleId, $eventName )

static

Unbinds REST event handler on PHP event.

Аргументы

string	$moduleId	Event owner module.
string	$eventName	Event name.

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

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

$defaultEventParams

$defaultEventParams

staticprotected

Инициализатор

= array(
        "category" => Sqs::CATEGORY_DEFAULT,
        "sendAuth" => true,
        "sendRefreshToken" => false,
    )

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

$forkSet

$forkSet = false

staticprotected

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

$initialized

$initialized = false

staticprotected

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

$provider

$provider

staticprotected

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

$providerOffline

$providerOffline

staticprotected

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

$queryData

$queryData = array()

staticprotected

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