Bitrix API

Auth

Table of Contents

Constants

AUTH_CODE_GUEST  = 'guest'
AUTH_CODE_REGISTER  = 'register'
AUTH_CUSTOM_ID_PARAM  = 'livechat_custom_auth_id'
AUTH_ID_PARAM  = 'livechat_auth_id'
AUTH_TYPE  = 'livechat'
AUTH_UID_PARAM  = 'livechat_user_id'
METHODS_WITH_AUTH  = [ // imopenlines 'imopenlines.widget.dialog.get', 'imopenlines.widget.dialog.list', 'imopenlines.widget.chat.create', 'imopenlines.widget.user.get', 'imopenlines.widget.operator.get', 'imopenlines.widget.user.consent.apply', 'imopenlines.widget.vote.send', 'imopenlines.widget.action.send', 'imopenlines.widget.crm.bindings.get', // pull 'server.time', 'pull.config.get', 'pull.watch.extend', // im 'im.chat.get', 'im.message.add', 'im.message.update', 'im.message.delete', 'im.message.like', 'im.dialog.writing', 'im.dialog.messages.get', 'im.dialog.read', 'im.disk.folder.get', 'im.disk.file.commit', // disk 'disk.folder.uploadfile', ]
METHODS_WITHOUT_AUTH  = ['imopenlines.widget.user.register', 'imopenlines.widget.user.get', 'imopenlines.widget.user.consent.apply', 'imopenlines.widget.config.get', 'imopenlines.widget.dialog.get', 'im.dialog.messages.get', 'im.chat.get', 'server.time', 'pull.config.get', 'smile.get']

Methods

authorizeById()  : mixed
onDiskCheckAuth()  : mixed
onRestCheckAuth()  : mixed

Constants

AUTH_CODE_GUEST

public mixed AUTH_CODE_GUEST = 'guest'

AUTH_CODE_REGISTER

public mixed AUTH_CODE_REGISTER = 'register'

AUTH_CUSTOM_ID_PARAM

public mixed AUTH_CUSTOM_ID_PARAM = 'livechat_custom_auth_id'

AUTH_ID_PARAM

public mixed AUTH_ID_PARAM = 'livechat_auth_id'

AUTH_TYPE

public mixed AUTH_TYPE = 'livechat'

AUTH_UID_PARAM

public mixed AUTH_UID_PARAM = 'livechat_user_id'

METHODS_WITH_AUTH

public mixed METHODS_WITH_AUTH = [ // imopenlines 'imopenlines.widget.dialog.get', 'imopenlines.widget.dialog.list', 'imopenlines.widget.chat.create', 'imopenlines.widget.user.get', 'imopenlines.widget.operator.get', 'imopenlines.widget.user.consent.apply', 'imopenlines.widget.vote.send', 'imopenlines.widget.action.send', 'imopenlines.widget.crm.bindings.get', // pull 'server.time', 'pull.config.get', 'pull.watch.extend', // im 'im.chat.get', 'im.message.add', 'im.message.update', 'im.message.delete', 'im.message.like', 'im.dialog.writing', 'im.dialog.messages.get', 'im.dialog.read', 'im.disk.folder.get', 'im.disk.file.commit', // disk 'disk.folder.uploadfile', ]

METHODS_WITHOUT_AUTH

public mixed METHODS_WITHOUT_AUTH = ['imopenlines.widget.user.register', 'imopenlines.widget.user.get', 'imopenlines.widget.user.consent.apply', 'imopenlines.widget.config.get', 'imopenlines.widget.dialog.get', 'im.dialog.messages.get', 'im.chat.get', 'server.time', 'pull.config.get', 'smile.get']

Methods

authorizeById()

public static authorizeById(mixed $userId[, mixed $setCookie = null ][, mixed $skipAuthorizeCheck = false ]) : mixed
Parameters
$userId : mixed
$setCookie : mixed = null
$skipAuthorizeCheck : mixed = false

onDiskCheckAuth()

public static onDiskCheckAuth(Event $event) : mixed
Parameters
$event : Event

onRestCheckAuth()

public static onRestCheckAuth(array<string|int, mixed> $query, mixed $scope, mixed &$res) : mixed
Parameters
$query : array<string|int, mixed>
$scope : mixed
$res : mixed

        
On this page

Search results