Класс ChatAuthProvider

Граф наследования:ChatAuthProvider:

Открытые члены
	__construct ()
	generateAccessCode (int $chatId)
	getNames ($codes)
	deleteByUser ($userId)
	addChatCodes (int $chatId, array $userIds)
	deleteChatCodes (int $chatId, ?array $userIds=null)
	isCodeAlreadyExists (int $chatId, int $userId)
	updateChatCodesByRelations (int $chatId)
	addUserCode (int $chatId, int $userId)
	removeUserCode (int $chatId, int $userId)

Открытые статические члены
static	getProviders ()

Защищенные данные
const	PROVIDER_ID = 'imchat'
const	ACCESS_CODE_PREFIX = 'CHAT'

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

Auth provider.

См. также

\CAccess todo: Implement full \IProviderInterface

RegisterModuleDependences("main", "OnAuthProvidersBuildList", "im", "\\Bitrix\\Im\\Access\\ChatAuthProvider", "getProviders");

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

Конструктор(ы)

__construct()

__construct

(

)

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

Методы

addChatCodes()

addChatCodes	(	int	$chatId,
		array	$userIds )

Add chat's access code for specific users.

Аргументы

int	$chatId
int[]	$userIds

Возвращает

void

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

addUserCode()

addUserCode	(	int	$chatId,
		int	$userId )

Adds user's access code to chat.

Аргументы

int	$chatId
int	$userId

Возвращает

void

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

deleteByUser()

deleteByUser

(

$userId

)

Removes user's access codes.

Аргументы

int

$userId

Возвращает

void

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

deleteChatCodes()

deleteChatCodes	(	int	$chatId,
		?array	$userIds = null )

Removes chat's access code.

Аргументы

int	$chatId
int[]	$userIds	For specific users.

Возвращает

void

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

generateAccessCode()

generateAccessCode

(

int

$chatId

)

Generates access code for chat. Ex: 'CHAT888'.

Аргументы

int

$chatId

Возвращает

string

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

getNames()

getNames

(

$codes

)

Returns restricted object names.

См. также

\CAccess::GetNames

\IProviderInterface::GetNames

Аргументы

string[]

$codes

Возвращает

array{provider: string, name: string}

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

getProviders()

static getProviders ( )

static

Event handler for main::OnAuthProvidersBuildList event.

См. также

\CAccess::__construct

Возвращает

array

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

isCodeAlreadyExists()

isCodeAlreadyExists	(	int	$chatId,
		int	$userId )

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

removeUserCode()

removeUserCode	(	int	$chatId,
		int	$userId )

Adds user's access code to chat.

Аргументы

int	$chatId
int	$userId

Возвращает

void

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

updateChatCodesByRelations()

updateChatCodesByRelations

(

int

$chatId

)

Updates chat's access codes.

Аргументы

int

$chatId

Возвращает

void

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

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

ACCESS_CODE_PREFIX

const ACCESS_CODE_PREFIX = 'CHAT'

protected

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

PROVIDER_ID

const PROVIDER_ID = 'imchat'

protected

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