Bitrix API

ChatAuthProvider extends CAuthProvider

Auth provider.

Tags
see
CAccess

todo: Implement full \IProviderInterface

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

Table of Contents

Methods

__construct()  : mixed
addChatCodes()  : void
Add chat's access code for specific users.
addUserCode()  : void
Adds user's access code to chat.
deleteByUser()  : void
Removes user's access codes.
deleteChatCodes()  : void
Removes chat's access code.
generateAccessCode()  : string
Generates access code for chat. Ex: 'CHAT888'.
getNames()  : array{provider: string, name: string}
Returns restricted object names.
getProviders()  : array<string|int, mixed>
Event handler for main::OnAuthProvidersBuildList event.
isCodeAlreadyExists()  : bool
removeUserCode()  : void
Adds user's access code to chat.
updateChatCodesByRelations()  : void
Updates chat's access codes.

Methods

addChatCodes()

Add chat's access code for specific users.

public addChatCodes(int $chatId, array<string|int, int> $userIds) : void
Parameters
$chatId : int
$userIds : array<string|int, int>

addUserCode()

Adds user's access code to chat.

public addUserCode(int $chatId, int $userId) : void
Parameters
$chatId : int
$userId : int

deleteByUser()

Removes user's access codes.

public deleteByUser(int $userId) : void
Parameters
$userId : int

deleteChatCodes()

Removes chat's access code.

public deleteChatCodes(int $chatId[, array<string|int, int> $userIds = null ]) : void
Parameters
$chatId : int
$userIds : array<string|int, int> = null

For specific users.

generateAccessCode()

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

public generateAccessCode(int $chatId) : string
Parameters
$chatId : int
Return values
string

getNames()

Returns restricted object names.

public getNames(array<string|int, string> $codes) : array{provider: string, name: string}
Parameters
$codes : array<string|int, string>
Tags
see
CAccess::GetNames
see
IProviderInterface::GetNames
Return values
array{provider: string, name: string}

getProviders()

Event handler for main::OnAuthProvidersBuildList event.

public static getProviders() : array<string|int, mixed>
Tags
see
CAccess::__construct
Return values
array<string|int, mixed>

isCodeAlreadyExists()

public isCodeAlreadyExists(int $chatId, int $userId) : bool
Parameters
$chatId : int
$userId : int
Return values
bool

removeUserCode()

Adds user's access code to chat.

public removeUserCode(int $chatId, int $userId) : void
Parameters
$chatId : int
$userId : int

updateChatCodesByRelations()

Updates chat's access codes.

public updateChatCodesByRelations(int $chatId) : void
Parameters
$chatId : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results