Bitrix API

TaskProvider

FinalYes

Table of Contents

Constants

COUNTER_EXPIRED  = 'expired'
COUNTER_NEW_COMMENTS  = 'new_comments'
COUNTER_NONE  = 'none'
ORDER_ACTIVITY  = 'ACTIVITY'
ORDER_DEADLINE  = 'DEADLINE'
PRESET_NONE  = 'none'

Methods

__construct()  : mixed
add()  : int
approve()  : bool
areAllScrumSubtasksCompleted()  : bool
attachUploadedFiles()  : DiskFileDto|null
complete()  : bool
defer()  : bool
delegate()  : bool
disapprove()  : bool
follow()  : bool
getFilter()  : array<string|int, mixed>
getFullTask()  : array<string|int, mixed>
getProjectDeadlineTasks()  : array<string|int, mixed>
getProjectKanbanTasks()  : array<string|int, mixed>
getProjectListTasks()  : array<string|int, mixed>
getProjectPlannerTasks()  : array<string|int, mixed>
getTask()  : TaskDto
getUserDeadlineTasks()  : array<string|int, mixed>
getUserListTasks()  : array<string|int, mixed>
getUserPlannerTasks()  : array<string|int, mixed>
mute()  : bool
pause()  : bool
pauseTimer()  : bool
pin()  : bool
ping()  : bool
read()  : bool
remove()  : bool
renew()  : bool
start()  : bool
startTimer()  : bool
take()  : bool
unfollow()  : bool
unmute()  : bool
unpin()  : bool
update()  : bool
updateParentIdToTaskIds()  : array<string|int, mixed>
updateRelatedTasks()  : array<string|int, mixed>

Constants

COUNTER_EXPIRED

public mixed COUNTER_EXPIRED = 'expired'

COUNTER_NEW_COMMENTS

public mixed COUNTER_NEW_COMMENTS = 'new_comments'

Methods

__construct()

public __construct(int $userId[, string $order = TaskProvider::ORDER_ACTIVITY ][, array<string|int, mixed> $extra = [] ][, TaskRequestFilter|null $searchParams = null ][, PageNavigation|null $pageNavigation = null ]) : mixed
Parameters
$userId : int
$order : string = TaskProvider::ORDER_ACTIVITY
$extra : array<string|int, mixed> = []
$searchParams : TaskRequestFilter|null = null
$pageNavigation : PageNavigation|null = null

add()

public add(array<string|int, mixed> $fields) : int
Parameters
$fields : array<string|int, mixed>
Tags
throws
CTaskAssertException
throws
TasksException
Return values
int

approve()

public approve(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

areAllScrumSubtasksCompleted()

public areAllScrumSubtasksCompleted(int $parentTaskId, int $groupId[, int $excludeSubtaskId = 0 ]) : bool
Parameters
$parentTaskId : int
$groupId : int
$excludeSubtaskId : int = 0
Return values
bool

complete()

public complete(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
throws
CTaskAssertException
throws
TasksException
Return values
bool

defer()

public defer(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

delegate()

public delegate(int $taskId, int $userId) : bool
Parameters
$taskId : int
$userId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

disapprove()

public disapprove(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

follow()

public follow(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

getFilter()

public getFilter(string|null $workMode, int|null $stageId, int|null $projectId) : array<string|int, mixed>
Parameters
$workMode : string|null
$stageId : int|null
$projectId : int|null
Return values
array<string|int, mixed>

getFullTask()

public getFullTask(int $taskId, string $workMode, int|null $kanbanOwnerId) : array<string|int, mixed>
Parameters
$taskId : int
$workMode : string
$kanbanOwnerId : int|null
Return values
array<string|int, mixed>

getProjectDeadlineTasks()

public getProjectDeadlineTasks(int $projectId, int|null $stageId) : array<string|int, mixed>
Parameters
$projectId : int
$stageId : int|null
Return values
array<string|int, mixed>

getProjectKanbanTasks()

public getProjectKanbanTasks(int $projectId, int|null $stageId) : array<string|int, mixed>
Parameters
$projectId : int
$stageId : int|null
Return values
array<string|int, mixed>

getProjectListTasks()

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

getProjectPlannerTasks()

public getProjectPlannerTasks(int $projectId, int|null $stageId) : array<string|int, mixed>
Parameters
$projectId : int
$stageId : int|null
Return values
array<string|int, mixed>

getUserDeadlineTasks()

public getUserDeadlineTasks(int|null $stageId) : array<string|int, mixed>
Parameters
$stageId : int|null
Return values
array<string|int, mixed>

getUserListTasks()

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

getUserPlannerTasks()

public getUserPlannerTasks(int|null $stageId) : array<string|int, mixed>
Parameters
$stageId : int|null
Return values
array<string|int, mixed>

mute()

public mute(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

pause()

public pause(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

pauseTimer()

public pauseTimer(int $taskId) : bool
Parameters
$taskId : int
Return values
bool

pin()

public pin(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

ping()

public ping(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

read()

public read(int $taskId) : bool
Parameters
$taskId : int
Return values
bool

remove()

public remove(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

renew()

public renew(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

start()

public start(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

startTimer()

public startTimer(int $taskId) : bool
Parameters
$taskId : int
Return values
bool

take()

public take(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

unfollow()

public unfollow(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

unmute()

public unmute(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

unpin()

public unpin(int $taskId) : bool
Parameters
$taskId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

update()

public update(int $taskId, array<string|int, mixed> $fields) : bool
Parameters
$taskId : int
$fields : array<string|int, mixed>
Tags
throws
CTaskAssertException
throws
TasksException
Return values
bool

updateParentIdToTaskIds()

public updateParentIdToTaskIds(int $parentId[, array<string|int, mixed>|null $newSubTasks = [] ][, array<string|int, mixed>|null $deletedSubTasks = [] ]) : array<string|int, mixed>
Parameters
$parentId : int
$newSubTasks : array<string|int, mixed>|null = []
$deletedSubTasks : array<string|int, mixed>|null = []
Return values
array<string|int, mixed>

updateRelatedTasks()

public updateRelatedTasks(int $taskId[, array<string|int, mixed>|null $newRelatedTasks = [] ][, array<string|int, mixed>|null $deletedRelatedTasks = [] ]) : array<string|int, mixed>
Parameters
$taskId : int
$newRelatedTasks : array<string|int, mixed>|null = []
$deletedRelatedTasks : array<string|int, mixed>|null = []
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results