Bitrix API

Workgroup extends Base

Table of Contents

Constants

ERROR_REQUIRED_PARAMETER  = 'MAIN_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION  = 'MAIN_CONTROLLER_22002'
EVENT_ON_AFTER_ACTION  = 'onAfterAction'
EVENT_ON_BEFORE_ACTION  = 'onBeforeAction'
EXCEPTION_UNKNOWN_ACTION  = 22002
SCOPE_AJAX  = 'ajax'
SCOPE_CLI  = 'cli'
SCOPE_REST  = 'rest'

Methods

__construct()  : mixed
Constructor Controller.
acceptIncomingRequestAction()  : array<string|int, mixed>|null
changePinAction()  : bool|null
className()  : string
Returns the fully qualified name of this class.
configureActions()  : array<string|int, mixed>
convertKeysToCamelCase()  : array<string|int, mixed>|mixed|string
Converts keys of array to camel case notation.
createGroupAction()  : array<string|int, mixed>
deleteAction()  : mixed
disconnectDepartmentsAction()  : mixed
finalizeResponse()  : void
Finalizes response.
forward()  : HttpResponse|mixed
generateActionMethodName()  : string
getAction()  : array<string|int, mixed>|null
getActionUri()  : Uri
Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.
getAutoWiredParameters()  : array<string|int, Parameter>
getAvatarTypesAction()  : array<string|int, mixed>
getCanCreateAction()  : bool
getChatIdAction()  : string|null
getConfigurationOfActions()  : array<string|int, mixed>|null
getCurrentUser()  : CurrentUser
getDefaultAutoWiredParameters()  : array<string|int, Parameter>
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getFullEventName()  : string
getGridPopupMembersAction()  : array<string|int, mixed>|null
getListIncomingUsersAction()  : array<string|int, mixed>|null
getModuleId()  : string
Returns module id.
getPrimaryAutoWiredParameter()  : Parameter|null
getRequest()  : HttpRequest
getScope()  : string
getSourceParametersList()  : array<string|int, mixed>
getUnsignedParameters()  : mixed
isExistingGroupAction()  : array<string|int, mixed>
isLocatedUnderPsr4()  : bool
leaveAction()  : mixed
listAction()  : mixed
listNameActions()  : array<string|int, mixed>
Returns list of all
redirectTo()  : Redirect
Redirect to URL.
rejectIncomingRequestAction()  : array<string|int, mixed>|null
run()  : HttpResponse|mixed
setCurrentUser()  : void
setFavoritesAction()  : array<string|int, mixed>|null
setFeatureAction()  : bool
setScope()  : Controller
setSourceParametersList()  : Controller
setSubscriptionAction()  : array<string|int, mixed>|null
turnOnTrialAction()  : bool
The method will enable trial mode for projects or scrum.
updateAction()  : bool|null
updateInvitedUsersAction()  : void
updatePhotoAction()  : bool

Constants

ERROR_REQUIRED_PARAMETER

public mixed ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'

ERROR_UNKNOWN_ACTION

public mixed ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'

EVENT_ON_AFTER_ACTION

public mixed EVENT_ON_AFTER_ACTION = 'onAfterAction'

EVENT_ON_BEFORE_ACTION

public mixed EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

EXCEPTION_UNKNOWN_ACTION

public mixed EXCEPTION_UNKNOWN_ACTION = 22002

Methods

__construct()

Constructor Controller.

public __construct([Request|null $request = null ]) : mixed
Parameters
$request : Request|null = null

acceptIncomingRequestAction()

public acceptIncomingRequestAction(int $groupId, array<string|int, mixed> $userIds) : array<string|int, mixed>|null
Parameters
$groupId : int
$userIds : array<string|int, mixed>
Return values
array<string|int, mixed>|null

changePinAction()

public changePinAction(array<string|int, mixed> $groupIdList, string $action[, string $componentName = '' ][, string $signedParameters = '' ]) : bool|null
Parameters
$groupIdList : array<string|int, mixed>
$action : string
$componentName : string = ''
$signedParameters : string = ''
Tags
restMethod

socialnetwork.api.workgroup.changePin

Return values
bool|null

className()

Returns the fully qualified name of this class.

public final static className() : string
Return values
string

configureActions()

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

convertKeysToCamelCase()

Converts keys of array to camel case notation.

public convertKeysToCamelCase(mixed $data) : array<string|int, mixed>|mixed|string
Parameters
$data : mixed

Data.

Tags
see
Converter::OUTPUT_JSON_FORMAT
Return values
array<string|int, mixed>|mixed|string

createGroupAction()

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

deleteAction()

public deleteAction(int $groupId) : mixed
Parameters
$groupId : int

disconnectDepartmentsAction()

public disconnectDepartmentsAction(int $groupId, array<string|int, mixed> $departmentIds) : mixed
Parameters
$groupId : int
$departmentIds : array<string|int, mixed>

finalizeResponse()

Finalizes response.

public finalizeResponse(Response $response) : void

The method will be invoked when HttpApplication will be ready to send response to client. It's a final place where Controller can interact with response.

Parameters
$response : Response

forward()

public forward(Controller|string $controller, string $actionName[, array<string|int, mixed>|null $parameters = null ]) : HttpResponse|mixed
Parameters
$controller : Controller|string
$actionName : string
$parameters : array<string|int, mixed>|null = null
Tags
throws
SystemException
Return values
HttpResponse|mixed

generateActionMethodName()

public final generateActionMethodName(mixed $action) : string
Parameters
$action : mixed
Return values
string

getAction()

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

getActionUri()

Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.

public final getActionUri(string $actionName[, array<string|int, mixed> $params = [] ][, bool $absolute = false ]) : Uri
Parameters
$actionName : string

Action name. It's a relative action name without controller name.

$params : array<string|int, mixed> = []

Parameters for creating uri.

$absolute : bool = false
Return values
Uri

getAvatarTypesAction()

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

getCanCreateAction()

public getCanCreateAction() : bool
Return values
bool

getChatIdAction()

public getChatIdAction(int $groupId) : string|null
Parameters
$groupId : int
Return values
string|null

getConfigurationOfActions()

public final getConfigurationOfActions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDefaultAutoWiredParameters()

public final getDefaultAutoWiredParameters() : array<string|int, Parameter>
Return values
array<string|int, Parameter>

getErrorByCode()

Getting once error with the necessary code.

public final getErrorByCode(string $code) : Error
Parameters
$code : string

Code of error.

Return values
Error

getErrors()

Getting array of errors.

public final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFullEventName()

public final static getFullEventName(mixed $eventName) : string
Parameters
$eventName : mixed
Return values
string

getGridPopupMembersAction()

public getGridPopupMembersAction(int $groupId, string $type, int $page[, string $componentName = '' ][, string $signedParameters = '' ]) : array<string|int, mixed>|null
Parameters
$groupId : int
$type : string
$page : int
$componentName : string = ''
$signedParameters : string = ''
Return values
array<string|int, mixed>|null

getListIncomingUsersAction()

public getListIncomingUsersAction(int $groupId, int $pageNum) : array<string|int, mixed>|null
Parameters
$groupId : int
$pageNum : int
Return values
array<string|int, mixed>|null

getModuleId()

Returns module id.

public final getModuleId() : string

Tries to guess module id by file path and function @see getModuleId().

Return values
string

getRequest()

public final getRequest() : HttpRequest
Return values
HttpRequest

getScope()

public final getScope() : string
Return values
string

getSourceParametersList()

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

getUnsignedParameters()

public final getUnsignedParameters() : mixed

isExistingGroupAction()

public isExistingGroupAction(string $name) : array<string|int, mixed>
Parameters
$name : string
Tags
restMethod

socialnetwork.api.workgroup.isExistingGroup

Return values
array<string|int, mixed>

isLocatedUnderPsr4()

public final isLocatedUnderPsr4() : bool
Return values
bool

leaveAction()

public leaveAction(int $groupId) : mixed
Parameters
$groupId : int

listAction()

public listAction(PageNavigation $pageNavigation[, array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $select = [] ][, array<string|int, mixed> $order = [] ][, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$pageNavigation : PageNavigation
$filter : array<string|int, mixed> = []
$select : array<string|int, mixed> = []
$order : array<string|int, mixed> = []
$params : array<string|int, mixed> = []

listNameActions()

Returns list of all

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

rejectIncomingRequestAction()

public rejectIncomingRequestAction(int $groupId, array<string|int, mixed> $userIds) : array<string|int, mixed>|null
Parameters
$groupId : int
$userIds : array<string|int, mixed>
Return values
array<string|int, mixed>|null

run()

public final run(mixed $actionName, array<string|int, mixed> $sourceParametersList) : HttpResponse|mixed
Parameters
$actionName : mixed
$sourceParametersList : array<string|int, mixed>
Tags
throws
SystemException
Return values
HttpResponse|mixed

setFavoritesAction()

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

setFeatureAction()

public setFeatureAction(int $groupId, array<string|int, mixed> $feature) : bool
Parameters
$groupId : int
$feature : array<string|int, mixed>
Return values
bool

setSourceParametersList()

public final setSourceParametersList(array<string|int, mixed> $sourceParametersList) : Controller
Parameters
$sourceParametersList : array<string|int, mixed>
Return values
Controller

setSubscriptionAction()

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

turnOnTrialAction()

The method will enable trial mode for projects or scrum.

public turnOnTrialAction([bool $scrum = false ]) : bool
Parameters
$scrum : bool = false

If you need to create a trial for scrum.

Return values
bool

updateAction()

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

updateInvitedUsersAction()

public updateInvitedUsersAction(int $spaceId, array<string|int, mixed> $users) : void
Parameters
$spaceId : int
$users : array<string|int, mixed>

updatePhotoAction()

public updatePhotoAction() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results