Bitrix API

Workgroup

Table of Contents

Methods

acceptIncomingRequest()  : bool
acceptOutgoingRequest()  : bool
canCreate()  : bool
checkAnyOpened()  : bool
deleteIncomingRequest()  : bool
deleteOutgoingRequest()  : bool
deleteRelation()  : bool
disconnectDepartment()  : bool
exclude()  : bool
getAdditionalData()  : array<string|int, mixed>
getAvatarColors()  : array<string|int, mixed>
getAvatarEntitySelectorUrl()  : string
getAvatarTypes()  : array<string|int, mixed>
getAvatarTypeWebCssClass()  : string
getByFeatureOperation()  : array<string|int, mixed>
returns array of workgroups filtered by access permissions of a user, only for the current site
getColoredAvatarTypes()  : array<string|int, mixed>
getConfidentialityPresets()  : array<string|int, mixed>
getConfidentialityTypeCodeByParams()  : mixed
getCurrentUserId()  : int
getDefaultAvatarTypes()  : array<string|int, mixed>
getEditFeaturesAvailability()  : mixed
getEmptyPermissions()  : array<string|int, mixed>
getPermissions()  : array<string|int, mixed>
getPresets()  : array<string|int, mixed>
getProjectPresets()  : array<string|int, mixed>
getProjectTypeCodeByParams()  : mixed
getScrumTaskResponsibleList()  : array<string|int, mixed>
getSprintDurationDefaultKey()  : mixed
getSprintDurationList()  : array<string|int, mixed>
getSprintDurationValues()  : array<string|int, mixed>
getTypeByCode()  : mixed
getTypeCodeByParams()  : mixed
getTypes()  : array<string|int, mixed>
isCurrentUserModuleAdmin()  : bool
isGroupCopyFeatureEnabled()  : bool
isProjectAccessFeatureEnabled()  : bool
isUsersHaveCommonGroups()  : bool
join()  : bool
leave()  : bool
mutateScrumFormFields()  : void
pin()  : bool|null
rejectIncomingRequest()  : bool
rejectOutgoingRequest()  : bool
removeModerator()  : bool
setArchive()  : bool
setModerator()  : bool
setModerators()  : bool
setOwner()  : bool
setScrumMaster()  : bool
unpin()  : bool|null

Methods

acceptIncomingRequest()

public static acceptIncomingRequest([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

acceptOutgoingRequest()

public static acceptOutgoingRequest([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

canCreate()

public static canCreate([array<string|int, mixed> $params = [] ]) : bool
Parameters
$params : array<string|int, mixed> = []
Return values
bool

checkAnyOpened()

public static checkAnyOpened([array<string|int, mixed> $idList = [] ]) : bool
Parameters
$idList : array<string|int, mixed> = []
Return values
bool

deleteIncomingRequest()

public static deleteIncomingRequest([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

deleteOutgoingRequest()

public static deleteOutgoingRequest([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

deleteRelation()

public static deleteRelation([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

disconnectDepartment()

public static disconnectDepartment([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

exclude()

public static exclude([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

getAdditionalData()

public static getAdditionalData([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getAvatarColors()

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

getAvatarEntitySelectorUrl()

public static getAvatarEntitySelectorUrl([mixed $type = '' ]) : string
Parameters
$type : mixed = ''
Return values
string

getAvatarTypes()

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

getAvatarTypeWebCssClass()

public static getAvatarTypeWebCssClass([mixed $type = '' ]) : string
Parameters
$type : mixed = ''
Return values
string

getByFeatureOperation()

returns array of workgroups filtered by access permissions of a user, only for the current site

public static getByFeatureOperation([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getColoredAvatarTypes()

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

getConfidentialityPresets()

public static getConfidentialityPresets([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getConfidentialityTypeCodeByParams()

public static getConfidentialityTypeCodeByParams(mixed $params) : mixed
Parameters
$params : mixed

getCurrentUserId()

public static getCurrentUserId() : int
Return values
int

getDefaultAvatarTypes()

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

getEditFeaturesAvailability()

public static getEditFeaturesAvailability() : mixed

getEmptyPermissions()

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

getPermissions()

public static getPermissions([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getPresets()

public static getPresets([mixed $params = [] ]) : array<string|int, mixed>
Parameters
$params : mixed = []
Return values
array<string|int, mixed>

getProjectPresets()

public static getProjectPresets([mixed $params = [] ]) : array<string|int, mixed>
Parameters
$params : mixed = []
Return values
array<string|int, mixed>

getProjectTypeCodeByParams()

public static getProjectTypeCodeByParams(mixed $params) : mixed
Parameters
$params : mixed

getScrumTaskResponsibleList()

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

getSprintDurationDefaultKey()

public static getSprintDurationDefaultKey() : mixed

getSprintDurationList()

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

getSprintDurationValues()

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

getTypeByCode()

public static getTypeByCode([mixed $params = [] ]) : mixed
Parameters
$params : mixed = []

getTypeCodeByParams()

public static getTypeCodeByParams(mixed $params) : mixed
Parameters
$params : mixed

getTypes()

public static getTypes([mixed $params = [] ]) : array<string|int, mixed>
Parameters
$params : mixed = []
Return values
array<string|int, mixed>

isCurrentUserModuleAdmin()

public static isCurrentUserModuleAdmin([bool $checkSession = false ]) : bool
Parameters
$checkSession : bool = false
Return values
bool

isGroupCopyFeatureEnabled()

public static isGroupCopyFeatureEnabled() : bool
Return values
bool

isProjectAccessFeatureEnabled()

public static isProjectAccessFeatureEnabled() : bool
Return values
bool

isUsersHaveCommonGroups()

public static isUsersHaveCommonGroups(int $userId, int $targetUserId[, bool $includeInvited = false ]) : bool
Parameters
$userId : int
$targetUserId : int
$includeInvited : bool = false
Return values
bool

join()

public static join([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

leave()

public static leave([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

mutateScrumFormFields()

public static mutateScrumFormFields([array<string|int, mixed> &$fields = [] ]) : void
Parameters
$fields : array<string|int, mixed> = []

pin()

public static pin(int $groupId[, string $mode = '' ]) : bool|null
Parameters
$groupId : int
$mode : string = ''
Return values
bool|null

rejectIncomingRequest()

public static rejectIncomingRequest([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

rejectOutgoingRequest()

public static rejectOutgoingRequest([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

removeModerator()

public static removeModerator([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

setArchive()

public static setArchive([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

setModerator()

public static setModerator([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

setModerators()

public static setModerators([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

setOwner()

public static setOwner([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

setScrumMaster()

public static setScrumMaster([array<string|int, mixed> $fields = [] ]) : bool
Parameters
$fields : array<string|int, mixed> = []
Return values
bool

unpin()

public static unpin(int $groupId[, string $mode = '' ]) : bool|null
Parameters
$groupId : int
$mode : string = ''
Return values
bool|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results