Bitrix API

Permission

Table of Contents

Constants

ACTION_CALL  = 'CALL'
ACTION_CHANGE_AVATAR  = 'AVATAR'
ACTION_CHANGE_COLOR  = 'COLOR'
ACTION_CHANGE_DESCRIPTION  = 'DESCRIPTION'
ACTION_CHANGE_MANAGERS  = 'CHANGE_MANAGERS'
ACTION_CHANGE_OWNER  = 'CHANGE_OWNER'
ACTION_CHANGE_RIGHTS  = 'RIGHT'
ACTION_CREATE_MEETING  = 'CREATE_MEETING'
ACTION_CREATE_TASK  = 'CREATE_TASK'
ACTION_DELETE  = 'DELETE'
ACTION_DELETE_OTHERS_MESSAGE  = 'DELETE_OTHERS_MESSAGE'
ACTION_EXTEND  = 'EXTEND'
ACTION_KICK  = 'KICK'
ACTION_LEAVE  = 'LEAVE'
ACTION_LEAVE_OWNER  = 'LEAVE_OWNER'
ACTION_MUTE  = 'MUTE'
ACTION_PIN_MESSAGE  = 'PIN_MESSAGE'
ACTION_RENAME  = 'RENAME'
ACTION_SEND  = 'SEND'
ACTION_UPDATE  = 'UPDATE'
ACTION_USER_LIST  = 'USER_LIST'
ACTIONS_MANAGE_MESSAGES  = [self::ACTION_SEND, self::ACTION_PIN_MESSAGE]
ACTIONS_MANAGE_SETTINGS  = [self::ACTION_CHANGE_RIGHTS, self::ACTION_CHANGE_OWNER, self::ACTION_CHANGE_MANAGERS]
ACTIONS_MANAGE_UI  = [self::ACTION_RENAME, self::ACTION_CHANGE_DESCRIPTION, self::ACTION_CHANGE_COLOR, self::ACTION_CHANGE_AVATAR]
ACTIONS_MANAGE_USERS_ADD  = [self::ACTION_EXTEND]
ACTIONS_MANAGE_USERS_DELETE  = [self::ACTION_KICK]
GROUP_ACTIONS  = [self::GROUP_MANAGE_UI => self::ACTIONS_MANAGE_UI, self::GROUP_MANAGE_USERS_ADD => self::ACTIONS_MANAGE_USERS_ADD, self::GROUP_MANAGE_USERS_DELETE => self::ACTIONS_MANAGE_USERS_DELETE, self::GROUP_MANAGE_SETTINGS => self::ACTIONS_MANAGE_SETTINGS, self::MANAGE_MESSAGES => self::ACTIONS_MANAGE_MESSAGES]
GROUP_ACTIONS_DEFAULT_PERMISSIONS  = [self::GROUP_MANAGE_UI => \Bitrix\Im\V2\Chat::ROLE_MEMBER, self::GROUP_MANAGE_USERS_ADD => \Bitrix\Im\V2\Chat::ROLE_MEMBER, self::GROUP_MANAGE_USERS_DELETE => \Bitrix\Im\V2\Chat::ROLE_MANAGER, self::GROUP_MANAGE_SETTINGS => \Bitrix\Im\V2\Chat::ROLE_OWNER, self::MANAGE_MESSAGES => \Bitrix\Im\V2\Chat::ROLE_MEMBER]
GROUP_MANAGE_SETTINGS  = 'MANAGE_SETTINGS'
GROUP_MANAGE_UI  = 'MANAGE_UI'
GROUP_MANAGE_USERS_ADD  = 'MANAGE_USERS_ADD'
GROUP_MANAGE_USERS_DELETE  = 'MANAGE_USERS_DELETE'
MANAGE_MESSAGES  = 'MANAGE_MESSAGES'
TYPE_ANNOUNCEMENT  = 'ANNOUNCEMENT'
TYPE_CHANNEL  = 'CHANNEL'
TYPE_COMMENT  = 'COMMENT'
TYPE_COPILOT  = 'COPILOT'
TYPE_DEFAULT  = 'DEFAULT'
TYPE_GENERAL  = 'GENERAL'
TYPE_GENERAL_CHANNEL  = 'GENERAL_CHANNEL'
TYPE_GROUP_CHAT  = 'CHAT'
TYPE_OPEN_CHANNEL  = 'OPEN_CHANNEL'
TYPE_OPEN_CHAT  = 'OPEN'
TYPE_PRIVATE  = 'PRIVATE'
TYPE_VIDEOCONF  = 'VIDEOCONF'

Methods

__construct()  : mixed
compareRole()  : bool
getActionGroupDefinitions()  : array<string|int, mixed>
getByChatTypes()  : array<string|int, mixed>
getDefaultPermissionForGroupActions()  : array<string|int, mixed>
getRoleForActionByType()  : string
getRoleGetListFilter()  : array<string|int, mixed>
getRoleOrmFilter()  : void
specifyAction()  : string

Constants

ACTION_CHANGE_AVATAR

public mixed ACTION_CHANGE_AVATAR = 'AVATAR'

ACTION_CHANGE_COLOR

public mixed ACTION_CHANGE_COLOR = 'COLOR'

ACTION_CHANGE_DESCRIPTION

public mixed ACTION_CHANGE_DESCRIPTION = 'DESCRIPTION'

ACTION_CHANGE_MANAGERS

public mixed ACTION_CHANGE_MANAGERS = 'CHANGE_MANAGERS'

ACTION_CHANGE_OWNER

public mixed ACTION_CHANGE_OWNER = 'CHANGE_OWNER'

ACTION_CHANGE_RIGHTS

public mixed ACTION_CHANGE_RIGHTS = 'RIGHT'

ACTION_CREATE_MEETING

public mixed ACTION_CREATE_MEETING = 'CREATE_MEETING'

ACTION_CREATE_TASK

public mixed ACTION_CREATE_TASK = 'CREATE_TASK'

ACTION_DELETE

public mixed ACTION_DELETE = 'DELETE'

ACTION_DELETE_OTHERS_MESSAGE

public mixed ACTION_DELETE_OTHERS_MESSAGE = 'DELETE_OTHERS_MESSAGE'

ACTION_EXTEND

public mixed ACTION_EXTEND = 'EXTEND'

ACTION_LEAVE

public mixed ACTION_LEAVE = 'LEAVE'

ACTION_LEAVE_OWNER

public mixed ACTION_LEAVE_OWNER = 'LEAVE_OWNER'

ACTION_PIN_MESSAGE

public mixed ACTION_PIN_MESSAGE = 'PIN_MESSAGE'

ACTION_RENAME

public mixed ACTION_RENAME = 'RENAME'

ACTION_UPDATE

public mixed ACTION_UPDATE = 'UPDATE'

ACTION_USER_LIST

public mixed ACTION_USER_LIST = 'USER_LIST'

ACTIONS_MANAGE_MESSAGES

public mixed ACTIONS_MANAGE_MESSAGES = [self::ACTION_SEND, self::ACTION_PIN_MESSAGE]

ACTIONS_MANAGE_SETTINGS

public mixed ACTIONS_MANAGE_SETTINGS = [self::ACTION_CHANGE_RIGHTS, self::ACTION_CHANGE_OWNER, self::ACTION_CHANGE_MANAGERS]

ACTIONS_MANAGE_UI

public mixed ACTIONS_MANAGE_UI = [self::ACTION_RENAME, self::ACTION_CHANGE_DESCRIPTION, self::ACTION_CHANGE_COLOR, self::ACTION_CHANGE_AVATAR]

ACTIONS_MANAGE_USERS_ADD

public mixed ACTIONS_MANAGE_USERS_ADD = [self::ACTION_EXTEND]

ACTIONS_MANAGE_USERS_DELETE

public mixed ACTIONS_MANAGE_USERS_DELETE = [self::ACTION_KICK]

GROUP_ACTIONS

public mixed GROUP_ACTIONS = [self::GROUP_MANAGE_UI => self::ACTIONS_MANAGE_UI, self::GROUP_MANAGE_USERS_ADD => self::ACTIONS_MANAGE_USERS_ADD, self::GROUP_MANAGE_USERS_DELETE => self::ACTIONS_MANAGE_USERS_DELETE, self::GROUP_MANAGE_SETTINGS => self::ACTIONS_MANAGE_SETTINGS, self::MANAGE_MESSAGES => self::ACTIONS_MANAGE_MESSAGES]

GROUP_ACTIONS_DEFAULT_PERMISSIONS

public mixed GROUP_ACTIONS_DEFAULT_PERMISSIONS = [self::GROUP_MANAGE_UI => \Bitrix\Im\V2\Chat::ROLE_MEMBER, self::GROUP_MANAGE_USERS_ADD => \Bitrix\Im\V2\Chat::ROLE_MEMBER, self::GROUP_MANAGE_USERS_DELETE => \Bitrix\Im\V2\Chat::ROLE_MANAGER, self::GROUP_MANAGE_SETTINGS => \Bitrix\Im\V2\Chat::ROLE_OWNER, self::MANAGE_MESSAGES => \Bitrix\Im\V2\Chat::ROLE_MEMBER]

GROUP_MANAGE_SETTINGS

public mixed GROUP_MANAGE_SETTINGS = 'MANAGE_SETTINGS'

GROUP_MANAGE_UI

public mixed GROUP_MANAGE_UI = 'MANAGE_UI'

GROUP_MANAGE_USERS_ADD

public mixed GROUP_MANAGE_USERS_ADD = 'MANAGE_USERS_ADD'

GROUP_MANAGE_USERS_DELETE

public mixed GROUP_MANAGE_USERS_DELETE = 'MANAGE_USERS_DELETE'

MANAGE_MESSAGES

public mixed MANAGE_MESSAGES = 'MANAGE_MESSAGES'

TYPE_ANNOUNCEMENT

public mixed TYPE_ANNOUNCEMENT = 'ANNOUNCEMENT'

TYPE_CHANNEL

public mixed TYPE_CHANNEL = 'CHANNEL'

TYPE_COMMENT

public mixed TYPE_COMMENT = 'COMMENT'

TYPE_COPILOT

public mixed TYPE_COPILOT = 'COPILOT'

TYPE_DEFAULT

public mixed TYPE_DEFAULT = 'DEFAULT'

TYPE_GENERAL

public mixed TYPE_GENERAL = 'GENERAL'

TYPE_GENERAL_CHANNEL

public mixed TYPE_GENERAL_CHANNEL = 'GENERAL_CHANNEL'

TYPE_GROUP_CHAT

public mixed TYPE_GROUP_CHAT = 'CHAT'

TYPE_OPEN_CHANNEL

public mixed TYPE_OPEN_CHANNEL = 'OPEN_CHANNEL'

TYPE_OPEN_CHAT

public mixed TYPE_OPEN_CHAT = 'OPEN'

TYPE_PRIVATE

public mixed TYPE_PRIVATE = 'PRIVATE'

TYPE_VIDEOCONF

public mixed TYPE_VIDEOCONF = 'VIDEOCONF'

Methods

__construct()

public __construct([bool $jsonFormat = true ]) : mixed
Parameters
$jsonFormat : bool = true

compareRole()

public static compareRole(string $userRole, string $needRole) : bool
Parameters
$userRole : string
$needRole : string
Return values
bool

getActionGroupDefinitions()

public getActionGroupDefinitions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getByChatTypes()

public getByChatTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDefaultPermissionForGroupActions()

public getDefaultPermissionForGroupActions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRoleForActionByType()

public static getRoleForActionByType(string $type, string $action) : string
Parameters
$type : string
$action : string
Return values
string

getRoleGetListFilter()

public static getRoleGetListFilter(array<string|int, mixed> $ormParams, string $action, string $relationTableAlias, string $chatTableAlias) : array<string|int, mixed>
Parameters
$ormParams : array<string|int, mixed>
$action : string
$relationTableAlias : string
$chatTableAlias : string
Return values
array<string|int, mixed>

getRoleOrmFilter()

public static getRoleOrmFilter(Query $query, string $action, string $relationTableAlias, string $chatTableAlias) : void
Parameters
$query : Query
$action : string
$relationTableAlias : string
$chatTableAlias : string

specifyAction()

public static specifyAction(string $actionName, Chat $targetChat, mixed $target) : string
Parameters
$actionName : string
$targetChat : Chat
$target : mixed
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results