Bitrix API

TaskService implements Errorable

Table of Contents

Interfaces

Errorable

Constants

ERROR_COULD_NOT_ADD_FILES_TASK  = 'TASKS_TS_09'
ERROR_COULD_NOT_ADD_TASK  = 'TASKS_TS_01'
ERROR_COULD_NOT_CHECK_COMPLETED_TASK  = 'TASKS_TS_13'
ERROR_COULD_NOT_CHECK_GET_SUB_TASK_IDS  = 'TASKS_TS_19'
ERROR_COULD_NOT_CHECK_GET_SUB_TASK_INFO  = 'TASKS_TS_20'
ERROR_COULD_NOT_CHECK_IS_LINKED_TASK  = 'TASKS_TS_18'
ERROR_COULD_NOT_CHECK_IS_SUB_TASK  = 'TASKS_TS_17'
ERROR_COULD_NOT_COMPLETE_TASK  = 'TASKS_TS_08'
ERROR_COULD_NOT_CONVERT_DESCRIPTION_TASK  = 'TASKS_TS_14'
ERROR_COULD_NOT_COUNT_CHECKLIST_FILES  = 'TASKS_TS_11'
ERROR_COULD_NOT_COUNT_COMMENTS_TASK  = 'TASKS_TS_12'
ERROR_COULD_NOT_READ_LIST_TASK  = 'TASKS_TS_15'
ERROR_COULD_NOT_READ_TAGS  = 'TASKS_TS_07'
ERROR_COULD_NOT_READ_TASK  = 'TASKS_TS_03'
ERROR_COULD_NOT_REMOVE_TAGS  = 'TASKS_TS_16'
ERROR_COULD_NOT_REMOVE_TASK  = 'TASKS_TS_04'
ERROR_COULD_NOT_UPDATE_TAGS  = 'TASKS_TS_06'
ERROR_COULD_NOT_UPDATE_TASK  = 'TASKS_TS_02'

Methods

__construct()  : mixed
addTaskMovingToLog()  : void
attachFilesToTask()  : array<string|int, mixed>
changeTask()  : bool
completeTasks()  : bool
convertDescription()  : string
createTask()  : int
getActualParentIds()  : array<string|int, mixed>
getAllowedTaskActions()  : array<string|int, mixed>
getErrorByCode()  : mixed
getErrors()  : mixed
getFilter()  : array<string|int, mixed>
getFilterInstance()  : Common|null
getItemsData()  : array<string|int, mixed>
The method returns an array of data in the required format for the client app.
getItemsDynamicData()  : array<string|int, mixed>
getLinkedTasks()  : array<string|int, mixed>
getOwnerId()  : int
getParentTaskId()  : int
getSubTaskIds()  : array<string|int, mixed>
getTags()  : array<string|int, mixed>
getTagsByTaskIds()  : array<string|int, mixed>
getTaskClosedDate()  : DateTime|null
getTaskIds()  : array<string|int, mixed>
Returns the ids of the group's not completed tasks.
getTaskIdsByFilter()  : array<string|int, mixed>
getTasksInfo()  : array<string|int, mixed>
getUncompletedTaskIds()  : array<string|int, mixed>
getUserId()  : int
hasAccessToCounters()  : bool
isCompletedTask()  : bool
mandatoryExists()  : bool
onAfterTaskAdd()  : mixed
onAfterTaskUpdate()  : mixed
removeTags()  : bool
removeTask()  : bool
setOwnerId()  : void
If your application is displaying another user's view, pass the id of the view owner to verify rights.
updateTagsList()  : bool
updateTaskLinks()  : void

Constants

ERROR_COULD_NOT_ADD_FILES_TASK

public mixed ERROR_COULD_NOT_ADD_FILES_TASK = 'TASKS_TS_09'

ERROR_COULD_NOT_ADD_TASK

public mixed ERROR_COULD_NOT_ADD_TASK = 'TASKS_TS_01'

ERROR_COULD_NOT_CHECK_COMPLETED_TASK

public mixed ERROR_COULD_NOT_CHECK_COMPLETED_TASK = 'TASKS_TS_13'

ERROR_COULD_NOT_CHECK_GET_SUB_TASK_IDS

public mixed ERROR_COULD_NOT_CHECK_GET_SUB_TASK_IDS = 'TASKS_TS_19'

ERROR_COULD_NOT_CHECK_GET_SUB_TASK_INFO

public mixed ERROR_COULD_NOT_CHECK_GET_SUB_TASK_INFO = 'TASKS_TS_20'

ERROR_COULD_NOT_CHECK_IS_LINKED_TASK

public mixed ERROR_COULD_NOT_CHECK_IS_LINKED_TASK = 'TASKS_TS_18'

ERROR_COULD_NOT_CHECK_IS_SUB_TASK

public mixed ERROR_COULD_NOT_CHECK_IS_SUB_TASK = 'TASKS_TS_17'

ERROR_COULD_NOT_COMPLETE_TASK

public mixed ERROR_COULD_NOT_COMPLETE_TASK = 'TASKS_TS_08'

ERROR_COULD_NOT_CONVERT_DESCRIPTION_TASK

public mixed ERROR_COULD_NOT_CONVERT_DESCRIPTION_TASK = 'TASKS_TS_14'

ERROR_COULD_NOT_COUNT_CHECKLIST_FILES

public mixed ERROR_COULD_NOT_COUNT_CHECKLIST_FILES = 'TASKS_TS_11'

ERROR_COULD_NOT_COUNT_COMMENTS_TASK

public mixed ERROR_COULD_NOT_COUNT_COMMENTS_TASK = 'TASKS_TS_12'

ERROR_COULD_NOT_READ_LIST_TASK

public mixed ERROR_COULD_NOT_READ_LIST_TASK = 'TASKS_TS_15'

ERROR_COULD_NOT_READ_TAGS

public mixed ERROR_COULD_NOT_READ_TAGS = 'TASKS_TS_07'

ERROR_COULD_NOT_READ_TASK

public mixed ERROR_COULD_NOT_READ_TASK = 'TASKS_TS_03'

ERROR_COULD_NOT_REMOVE_TAGS

public mixed ERROR_COULD_NOT_REMOVE_TAGS = 'TASKS_TS_16'

ERROR_COULD_NOT_REMOVE_TASK

public mixed ERROR_COULD_NOT_REMOVE_TASK = 'TASKS_TS_04'

ERROR_COULD_NOT_UPDATE_TAGS

public mixed ERROR_COULD_NOT_UPDATE_TAGS = 'TASKS_TS_06'

ERROR_COULD_NOT_UPDATE_TASK

public mixed ERROR_COULD_NOT_UPDATE_TASK = 'TASKS_TS_02'

Methods

__construct()

public __construct(int $executiveUserId[, CMain $application = null ]) : mixed
Parameters
$executiveUserId : int
$application : CMain = null

addTaskMovingToLog()

public static addTaskMovingToLog(int $taskId, int $groupId) : void
Parameters
$taskId : int
$groupId : int

attachFilesToTask()

public attachFilesToTask(CUserTypeManager $manager, int $taskId, array<string|int, mixed> $attachedIds) : array<string|int, mixed>
Parameters
$manager : CUserTypeManager
$taskId : int
$attachedIds : array<string|int, mixed>
Return values
array<string|int, mixed>

changeTask()

public changeTask(int $taskId, array<string|int, mixed> $taskFields) : bool
Parameters
$taskId : int
$taskFields : array<string|int, mixed>
Return values
bool

completeTasks()

public completeTasks(array<string|int, mixed> $taskIds) : bool
Parameters
$taskIds : array<string|int, mixed>
Return values
bool

convertDescription()

public convertDescription(string $text, mixed $ufFields) : string
Parameters
$text : string
$ufFields : mixed
Return values
string

createTask()

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

getActualParentIds()

public getActualParentIds(array<string|int, mixed> $parentIds, int $groupId) : array<string|int, mixed>
Parameters
$parentIds : array<string|int, mixed>
$groupId : int
Return values
array<string|int, mixed>

getAllowedTaskActions()

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

getErrorByCode()

public getErrorByCode(mixed $code) : mixed
Parameters
$code : mixed

getFilter()

public getFilter(Common $filterInstance) : array<string|int, mixed>
Parameters
$filterInstance : Common
Return values
array<string|int, mixed>

getFilterInstance()

public getFilterInstance(int $groupId[, string $view = 'plan' ]) : Common|null
Parameters
$groupId : int
$view : string = 'plan'
Return values
Common|null

getItemsData()

The method returns an array of data in the required format for the client app.

public getItemsData(array<string|int, mixed> $taskIds) : array<string|int, mixed>
Parameters
$taskIds : array<string|int, mixed>

Task ids.

Return values
array<string|int, mixed>

getItemsDynamicData()

public getItemsDynamicData(int $groupId, array<string|int, mixed> $taskIds, mixed $itemsData) : array<string|int, mixed>
Parameters
$groupId : int
$taskIds : array<string|int, mixed>
$itemsData : mixed
Return values
array<string|int, mixed>

getLinkedTasks()

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

getOwnerId()

public getOwnerId() : int
Return values
int

getParentTaskId()

public getParentTaskId(int $taskId, int $groupId) : int
Parameters
$taskId : int
$groupId : int
Return values
int

getSubTaskIds()

public getSubTaskIds(int $groupId, int $taskId[, bool $notCompleted = true ]) : array<string|int, mixed>
Parameters
$groupId : int
$taskId : int
$notCompleted : bool = true
Return values
array<string|int, mixed>

getTags()

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

getTagsByTaskIds()

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

getTaskClosedDate()

public getTaskClosedDate(mixed $taskId) : DateTime|null
Parameters
$taskId : mixed
Return values
DateTime|null

getTaskIds()

Returns the ids of the group's not completed tasks.

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

getTaskIdsByFilter()

public getTaskIdsByFilter(array<string|int, mixed> $filter[, PageNavigation|null $navigation = null ][, array<string|int, mixed> $entityIds = [] ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed>
$navigation : PageNavigation|null = null
$entityIds : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getTasksInfo()

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

getUncompletedTaskIds()

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

getUserId()

public getUserId() : int
Return values
int

hasAccessToCounters()

public hasAccessToCounters() : bool
Return values
bool

isCompletedTask()

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

mandatoryExists()

public mandatoryExists() : bool
Return values
bool

onAfterTaskAdd()

public static onAfterTaskAdd(int $taskId, array<string|int, mixed> &$fields) : mixed
Parameters
$taskId : int
$fields : array<string|int, mixed>

onAfterTaskUpdate()

public static onAfterTaskUpdate(int $taskId, array<string|int, mixed> &$fields, array<string|int, mixed>|null &$previousFields) : mixed
Parameters
$taskId : int
$fields : array<string|int, mixed>
$previousFields : array<string|int, mixed>|null

removeTags()

public removeTags(int $taskId, string $inputTag) : bool
Parameters
$taskId : int
$inputTag : string
Return values
bool

removeTask()

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

setOwnerId()

If your application is displaying another user's view, pass the id of the view owner to verify rights.

public setOwnerId(int $ownerId) : void
Parameters
$ownerId : int

updateTagsList()

public updateTagsList(int $taskId, array<string|int, mixed> $inputTags) : bool
Parameters
$taskId : int
$inputTags : array<string|int, mixed>
Return values
bool

updateTaskLinks()

public updateTaskLinks(int $parentTaskId, int $childTaskId) : void
Parameters
$parentTaskId : int
$childTaskId : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results