Bitrix API

Task extends RestrictedAction

FinalYes

Table of Contents

Methods

__construct()  : mixed
add()  : mixed
Add a new task
addAccomplice()  : array<string|int, mixed>
addAuditor()  : array<string|int, mixed>
addtofavorite()  : array<string|int, mixed>
adjustDeadline()  : array<string|int, mixed>
approve()  : mixed
Approve (confirm the result of) a specified task
canExecute()  : mixed
checkCanRead()  : mixed
Check if a specified task is readable by the current user
complete()  : mixed
Complete a specified task
defer()  : mixed
Defer (put aside) a specified task
delegate()  : mixed
Delegates a task to a new responsible
delete()  : mixed
Delete a task
disapprove()  : mixed
Disapprove (reject the result of) a specified task
enterAuditor()  : mixed
Become an auditor of a specified task
find()  : mixed
get()  : mixed
Get a task
getComponentHTML()  : mixed
getErrorCollection()  : mixed
getErrors()  : mixed
getForbiddenMethods()  : array<string|int, mixed>
todo: replace this method with some phpdoc notation
getList()  : mixed
Get a list of tasks
isVersionGT()  : mixed
leaveAuditor()  : mixed
Stop being an auditor of a specified task
mute()  : Result
pause()  : mixed
Pause execution of a specified task
pin()  : mixed
ping()  : array<string|int, mixed>
removefromfavorite()  : array<string|int, mixed>
renew()  : mixed
Renew (switch to status "pending, await execution") a specified task
setdeadline()  : array<string|int, mixed>
setGroup()  : array<string|int, mixed>
setOriginator()  : array<string|int, mixed>
setResponsible()  : array<string|int, mixed>
settaskcontrol()  : array<string|int, mixed>
start()  : mixed
Start execution of a specified task
substractDeadline()  : array<string|int, mixed>
unmute()  : mixed
unpin()  : mixed
update()  : mixed
Update a task with some new data

Methods

add()

Add a new task

public add(array<string|int, mixed> $data[, array<string|int, mixed> $parameters = ['RETURN_DATA' => false] ]) : mixed
Parameters
$data : array<string|int, mixed>
$parameters : array<string|int, mixed> = ['RETURN_DATA' => false]

addAccomplice()

public addAccomplice(mixed $id, mixed $accompliceId) : array<string|int, mixed>
Parameters
$id : mixed
$accompliceId : mixed
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

addAuditor()

public addAuditor(mixed $id, mixed $auditorId) : array<string|int, mixed>
Parameters
$id : mixed
$auditorId : mixed
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

addtofavorite()

public addtofavorite(mixed $id[, array<string|int, mixed> $parameters = array() ]) : array<string|int, mixed>
Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

adjustDeadline()

public adjustDeadline(mixed $id, mixed $num, mixed $type[, array<string|int, mixed> $parameters = array() ]) : array<string|int, mixed>
Parameters
$id : mixed
$num : mixed
$type : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

approve()

Approve (confirm the result of) a specified task

public approve(mixed $id) : mixed
Parameters
$id : mixed

checkCanRead()

Check if a specified task is readable by the current user

public checkCanRead(mixed $id) : mixed
Parameters
$id : mixed

complete()

Complete a specified task

public complete(mixed $id) : mixed
Parameters
$id : mixed

defer()

Defer (put aside) a specified task

public defer(mixed $id) : mixed
Parameters
$id : mixed

delegate()

Delegates a task to a new responsible

public delegate(mixed $id, mixed $userId) : mixed
Parameters
$id : mixed
$userId : mixed

delete()

Delete a task

public delete(mixed $id[, array<string|int, mixed> $parameters = array() ]) : mixed

Access rights will be check into the CTaskItem

Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()

disapprove()

Disapprove (reject the result of) a specified task

public disapprove(mixed $id) : mixed
Parameters
$id : mixed

enterAuditor()

Become an auditor of a specified task

public enterAuditor(mixed $id) : mixed
Parameters
$id : mixed

find()

public find([array<string|int, mixed> $parameters = array() ]) : mixed

since tasks 21.200.0

Get a list of tasks

Access rights will be check into the Task

Parameters
$parameters : array<string|int, mixed> = array()

get()

Get a task

public get(mixed $id[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()

getComponentHTML()

public static getComponentHTML(mixed $name[, mixed $template = '' ][, array<string|int, mixed> $callParameters = array() ][, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$name : mixed
$template : mixed = ''
$callParameters : array<string|int, mixed> = array()
$parameters : array<string|int, mixed> = array()

getErrorCollection()

public getErrorCollection() : mixed

getForbiddenMethods()

todo: replace this method with some phpdoc notation

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

getList()

Get a list of tasks

public getList([array<string|int, mixed> $order = array() ][, array<string|int, mixed> $filter = array() ][, array<string|int, mixed> $select = array() ][, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$order : array<string|int, mixed> = array()
$filter : array<string|int, mixed> = array()
$select : array<string|int, mixed> = array()
$parameters : array<string|int, mixed> = array()
Tags
see
Task::find

Access rights will be check into the CTasks::GetList()

leaveAuditor()

Stop being an auditor of a specified task

public leaveAuditor(mixed $id) : mixed
Parameters
$id : mixed

mute()

public mute(mixed $id) : Result
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

pause()

Pause execution of a specified task

public pause(mixed $id) : mixed

Access rights will be check into the CTaskItem

Parameters
$id : mixed

pin()

public pin(mixed $id[, mixed $groupId = 0 ]) : mixed
Parameters
$id : mixed
$groupId : mixed = 0

ping()

public ping(mixed $id) : array<string|int, mixed>
Parameters
$id : mixed
Return values
array<string|int, mixed>

removefromfavorite()

public removefromfavorite(mixed $id[, array<string|int, mixed> $parameters = array() ]) : array<string|int, mixed>
Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

renew()

Renew (switch to status "pending, await execution") a specified task

public renew(mixed $id) : mixed
Parameters
$id : mixed

setdeadline()

public setdeadline(mixed $id, mixed $newDeadline[, array<string|int, mixed> $parameters = array() ]) : array<string|int, mixed>
Parameters
$id : mixed
$newDeadline : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

setGroup()

public setGroup(mixed $id, mixed $groupId) : array<string|int, mixed>
Parameters
$id : mixed
$groupId : mixed
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

setOriginator()

public setOriginator(mixed $id, mixed $originatorId) : array<string|int, mixed>
Parameters
$id : mixed
$originatorId : mixed
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

setResponsible()

public setResponsible(mixed $id, mixed $responsibleId) : array<string|int, mixed>
Parameters
$id : mixed
$responsibleId : mixed
Tags
throws
CTaskAssertException
Return values
array<string|int, mixed>

settaskcontrol()

public settaskcontrol(mixed $id, mixed $value[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>
Parameters
$id : mixed
$value : mixed
$parameters : array<string|int, mixed> = []
Tags
throws
CTaskAssertException

Access rights will be check into the CTaskItem

Return values
array<string|int, mixed>

start()

Start execution of a specified task

public start(mixed $id) : mixed
Parameters
$id : mixed

substractDeadline()

public substractDeadline(mixed $id, mixed $num, mixed $type[, array<string|int, mixed> $parameters = array() ]) : array<string|int, mixed>
Parameters
$id : mixed
$num : mixed
$type : mixed
$parameters : array<string|int, mixed> = array()
Return values
array<string|int, mixed>

unmute()

public unmute(mixed $id) : mixed
Parameters
$id : mixed

unpin()

public unpin(mixed $id[, mixed $groupId = 0 ]) : mixed
Parameters
$id : mixed
$groupId : mixed = 0

update()

Update a task with some new data

public update(mixed $id, array<string|int, mixed> $data[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$id : mixed
$data : array<string|int, mixed>
$parameters : array<string|int, mixed> = array() 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results