Bitrix API

Task extends Base

FinalYes

Class Task

Tags
restController

tasks.task

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.
addAccomplicesAction()  : array<string|int, mixed>|null
addAction()  : array<string|int, mixed>|null
Create new task
addAuditorsAction()  : array<string|int, mixed>|null
approveAction()  : array<string|int, mixed>|null
Approve task
className()  : string
Returns the fully qualified name of this class.
completeAction()  : array<string|int, mixed>|null
Complete task
configureActions()  : array<string|int, mixed>
convertKeysToCamelCase()  : array<string|int, mixed>|mixed|string
Converts keys of array to camel case notation.
deferAction()  : array<string|int, mixed>|null
Defer task
delegateAction()  : array<string|int, mixed>|null
Delegate task to another user
deleteAction()  : array<string|int, mixed>|null
Remove existing task
disapproveAction()  : array<string|int, mixed>|null
Disapprove task
finalizeResponse()  : void
Finalizes response.
forward()  : HttpResponse|mixed
generateActionMethodName()  : string
getAccessAction()  : array<string|int, mixed>
Return access data to task for current user
getAction()  : array<string|int, mixed>
Get task item data
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>
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.
getFieldsAction()  : array<string|int, mixed>
Return all DB and UF_ fields of task
getFullEventName()  : string
getGridRowsAction()  : array<string|int, mixed>|null
getModuleId()  : string
Returns module id.
getNearTasksAction()  : array<string|int, mixed>|null
getPrimaryAutoWiredParameter()  : Parameter|null
getRequest()  : HttpRequest
getScope()  : string
getSourceParametersList()  : array<string|int, mixed>
getUnsignedParameters()  : mixed
isLocatedUnderPsr4()  : bool
listAction()  : Page|null
Get list all task
listNameActions()  : array<string|int, mixed>
Returns list of all
muteAction()  : array<string|int, mixed>|null
pauseAction()  : array<string|int, mixed>|null
Stop execute task
pauseTimerAction()  : array<string|int, mixed>|null
pinAction()  : array<string|int, mixed>|null
pingAction()  : bool|null
redirectTo()  : Redirect
Redirect to URL.
renewAction()  : array<string|int, mixed>|null
Renew task after complete
run()  : HttpResponse|mixed
sendAnalyticsLabelAction()  : void
setCurrentUser()  : void
setScope()  : Controller
setSourceParametersList()  : Controller
startAction()  : array<string|int, mixed>|null
Start execute task
startTimerAction()  : array<string|int, mixed>|null
startWatchAction()  : array<string|int, mixed>|null
Become an auditor of a specified task
stopWatchAction()  : array<string|int, mixed>|null
Stop being an auditor of a specified task
takeAction()  : array<string|int, mixed>|null
Take task from himself distribution flow
unmuteAction()  : array<string|int, mixed>|null
unpinAction()  : array<string|int, mixed>|null
updateAction()  : array<string|int, mixed>|null
Update existing task

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

addAccomplicesAction()

public addAccomplicesAction(CTaskItem $task[, array<string|int, mixed> $accomplicesIds = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$accomplicesIds : array<string|int, mixed> = []
Tags
restMethod

tasks.task.addAccomplices

Return values
array<string|int, mixed>|null

addAction()

Create new task

public addAction(array<string|int, mixed> $fields[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$fields : array<string|int, mixed>
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.add

Return values
array<string|int, mixed>|null

addAuditorsAction()

public addAuditorsAction(CTaskItem $task[, array<string|int, mixed> $auditorsIds = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$auditorsIds : array<string|int, mixed> = []
Tags
restMethod

tasks.task.addAuditors

Return values
array<string|int, mixed>|null

approveAction()

Approve task

public approveAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.approve

Return values
array<string|int, mixed>|null

className()

Returns the fully qualified name of this class.

public final static className() : string
Return values
string

completeAction()

Complete task

public completeAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.complete

Return values
array<string|int, mixed>|null

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

deferAction()

Defer task

public deferAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.defer

Return values
array<string|int, mixed>|null

delegateAction()

Delegate task to another user

public delegateAction(CTaskItem $task, mixed $userId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$userId : mixed
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.delegate

Return values
array<string|int, mixed>|null

deleteAction()

Remove existing task

public deleteAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.delete

Return values
array<string|int, mixed>|null

disapproveAction()

Disapprove task

public disapproveAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.disapprove

Return values
array<string|int, mixed>|null

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

getAccessAction()

Return access data to task for current user

public getAccessAction(CTaskItem $task[, array<string|int, mixed> $users = [] ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$task : CTaskItem
$users : array<string|int, mixed> = []
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.getAccess

Return values
array<string|int, mixed>

getAction()

Get task item data

public getAction(CTaskItem $task[, array<string|int, mixed> $select = [] ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$task : CTaskItem
$select : array<string|int, mixed> = []
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.get

Return values
array<string|int, mixed>

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

getAutoWiredParameters()

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

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>

getFieldsAction()

Return all DB and UF_ fields of task

public getFieldsAction() : array<string|int, mixed>
Tags
restMethod

tasks.task.getFields

Return values
array<string|int, mixed>

getFullEventName()

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

getGridRowsAction()

public getGridRowsAction([array<string|int, mixed> $taskIds = [] ][, array<string|int, mixed> $navigation = [] ][, array<string|int, mixed> $arParams = [] ]) : array<string|int, mixed>|null
Parameters
$taskIds : array<string|int, mixed> = []
$navigation : array<string|int, mixed> = []
$arParams : array<string|int, mixed> = []
Tags
restMethod

tasks.task.getGridRows

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

getNearTasksAction()

public getNearTasksAction(array<string|int, mixed> $taskIds, array<string|int, mixed> $navigation[, array<string|int, mixed> $arParams = [] ]) : array<string|int, mixed>|null
Parameters
$taskIds : array<string|int, mixed>
$navigation : array<string|int, mixed>
$arParams : array<string|int, mixed> = []
Tags
restMethod

tasks.task.getNearTasks

Return values
array<string|int, mixed>|null

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

isLocatedUnderPsr4()

public final isLocatedUnderPsr4() : bool
Return values
bool

listAction()

Get list all task

public listAction([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $select = [] ][, array<string|int, mixed> $group = [] ][, array<string|int, mixed> $order = [] ][, array<string|int, mixed> $params = [] ][, PageNavigation $pageNavigation = null ][, bool $__calculateTotalCount = true ]) : Page|null
Parameters
$filter : array<string|int, mixed> = []
$select : array<string|int, mixed> = []
$group : array<string|int, mixed> = []
$order : array<string|int, mixed> = []
$params : array<string|int, mixed> = []
$pageNavigation : PageNavigation = null
$__calculateTotalCount : bool = true
Tags
restMethod

tasks.task.list

Return values
Page|null

listNameActions()

Returns list of all

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

muteAction()

public muteAction(CTaskItem $task) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.mute

Return values
array<string|int, mixed>|null

pauseAction()

Stop execute task

public pauseAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.pause

Return values
array<string|int, mixed>|null

pauseTimerAction()

public pauseTimerAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.pauseTimer

Return values
array<string|int, mixed>|null

pinAction()

public pinAction(CTaskItem $task) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.pin

Return values
array<string|int, mixed>|null

pingAction()

public pingAction(CTaskItem $task) : bool|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.ping

Return values
bool|null

renewAction()

Renew task after complete

public renewAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.renew

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

sendAnalyticsLabelAction()

public sendAnalyticsLabelAction() : void
Tags
restMethod

tasks.task.sendAnalyticsLabel

setSourceParametersList()

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

startAction()

Start execute task

public startAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.start

Return values
array<string|int, mixed>|null

startTimerAction()

public startTimerAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.startTimer

Return values
array<string|int, mixed>|null

startWatchAction()

Become an auditor of a specified task

public startWatchAction(CTaskItem $task) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.startWatch

Return values
array<string|int, mixed>|null

stopWatchAction()

Stop being an auditor of a specified task

public stopWatchAction(CTaskItem $task) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.stopWatch

Return values
array<string|int, mixed>|null

takeAction()

Take task from himself distribution flow

public takeAction(CTaskItem $task[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.take

Return values
array<string|int, mixed>|null

unmuteAction()

public unmuteAction(CTaskItem $task) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.unmute

Return values
array<string|int, mixed>|null

unpinAction()

public unpinAction(CTaskItem $task) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
Tags
restMethod

tasks.task.unpin

Return values
array<string|int, mixed>|null

updateAction()

Update existing task

public updateAction(CTaskItem $task, array<string|int, mixed> $fields[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$task : CTaskItem
$fields : array<string|int, mixed>
$params : array<string|int, mixed> = []
Tags
restMethod

tasks.task.update

Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results