Bitrix API

SprintService implements Errorable

Table of Contents

Interfaces

Errorable

Constants

ERROR_COULD_NOT_ADD_SPRINT  = 'TASKS_SS_01'
ERROR_COULD_NOT_CHANGE_SORT  = 'TASKS_SS_09'
ERROR_COULD_NOT_COMPLETE_SPRINT  = 'TASKS_SS_06'
ERROR_COULD_NOT_READ_LAST_COMPLETED_SPRINT  = 'TASKS_SS_14'
ERROR_COULD_NOT_READ_PLANNED_SPRINTS  = 'TASKS_SS_13'
ERROR_COULD_NOT_READ_SPRINT  = 'TASKS_SS_03'
ERROR_COULD_NOT_READ_SPRINT_BY_GROUP  = 'TASKS_SS_10'
ERROR_COULD_NOT_READ_SPRINT_BY_ID  = 'TASKS_SS_15'
ERROR_COULD_NOT_REMOVE_SPRINT  = 'TASKS_SS_04'
ERROR_COULD_NOT_START_SPRINT  = 'TASKS_SS_05'
ERROR_COULD_NOT_UPDATE_SPRINT  = 'TASKS_SS_02'

Methods

__construct()  : mixed
canCompleteSprint()  : bool
canStartSprint()  : bool
changeSort()  : void
changeSprint()  : bool
completeSprint()  : EntityForm
createSprint()  : EntityForm
getActiveSprintByGroupId()  : EntityForm
Gets active sprint by group id.
getCompletedSprints()  : array<string|int, mixed>
getCompletedStoryPoints()  : float
getCompletedStoryPointsMap()  : array<string|int, mixed>
getCompletedTasksMap()  : array<string|int, mixed>
getDateEndFromLastPlannedSprint()  : int|null
The method returns the end date of the last planned sprint.
getErrorByCode()  : mixed
getErrors()  : mixed
getLastCompletedSprint()  : EntityForm
Returns a last completed sprint by scrum group id.
getPlannedSprints()  : array<string|int, EntityForm>
The method returns the planned sprints of the project.
getSprintById()  : EntityForm
getSprintData()  : array<string|int, mixed>
The method returns an array of data in the required format for the client app.
getSprintRanges()  : SprintRanges
The method returns object with info about the time sprint days of the sprint.
getSprintsByGroupId()  : array<string|int, EntityForm>
Returns an array objects with sprints by scrum group id.
getUncompletedSprints()  : array<string|int, mixed>
getUnCompletedStoryPoints()  : float
removeSprint()  : bool
startSprint()  : EntityForm

Constants

ERROR_COULD_NOT_ADD_SPRINT

public mixed ERROR_COULD_NOT_ADD_SPRINT = 'TASKS_SS_01'

ERROR_COULD_NOT_CHANGE_SORT

public mixed ERROR_COULD_NOT_CHANGE_SORT = 'TASKS_SS_09'

ERROR_COULD_NOT_COMPLETE_SPRINT

public mixed ERROR_COULD_NOT_COMPLETE_SPRINT = 'TASKS_SS_06'

ERROR_COULD_NOT_READ_LAST_COMPLETED_SPRINT

public mixed ERROR_COULD_NOT_READ_LAST_COMPLETED_SPRINT = 'TASKS_SS_14'

ERROR_COULD_NOT_READ_PLANNED_SPRINTS

public mixed ERROR_COULD_NOT_READ_PLANNED_SPRINTS = 'TASKS_SS_13'

ERROR_COULD_NOT_READ_SPRINT

public mixed ERROR_COULD_NOT_READ_SPRINT = 'TASKS_SS_03'

ERROR_COULD_NOT_READ_SPRINT_BY_GROUP

public mixed ERROR_COULD_NOT_READ_SPRINT_BY_GROUP = 'TASKS_SS_10'

ERROR_COULD_NOT_READ_SPRINT_BY_ID

public mixed ERROR_COULD_NOT_READ_SPRINT_BY_ID = 'TASKS_SS_15'

ERROR_COULD_NOT_REMOVE_SPRINT

public mixed ERROR_COULD_NOT_REMOVE_SPRINT = 'TASKS_SS_04'

ERROR_COULD_NOT_START_SPRINT

public mixed ERROR_COULD_NOT_START_SPRINT = 'TASKS_SS_05'

ERROR_COULD_NOT_UPDATE_SPRINT

public mixed ERROR_COULD_NOT_UPDATE_SPRINT = 'TASKS_SS_02'

Methods

__construct()

public __construct([int $userId = 0 ]) : mixed
Parameters
$userId : int = 0

canCompleteSprint()

public canCompleteSprint(int $userId, int $groupId) : bool
Parameters
$userId : int
$groupId : int
Return values
bool

canStartSprint()

public canStartSprint(int $userId, int $groupId) : bool
Parameters
$userId : int
$groupId : int
Return values
bool

changeSort()

public changeSort(array<string|int, mixed> $sortInfo) : void
Parameters
$sortInfo : array<string|int, mixed>

completeSprint()

public completeSprint(EntityForm $sprint, EntityService $entityService, TaskService $taskService, KanbanService $kanbanService, ItemService $itemService[, int $targetEntityId = 0 ][, PushService $pushService = null ]) : EntityForm
Parameters
$sprint : EntityForm
$entityService : EntityService
$taskService : TaskService
$kanbanService : KanbanService
$itemService : ItemService
$targetEntityId : int = 0
$pushService : PushService = null
Return values
EntityForm

getActiveSprintByGroupId()

Gets active sprint by group id.

public getActiveSprintByGroupId(int $groupId) : EntityForm
Parameters
$groupId : int

Group id.

Return values
EntityForm

getCompletedSprints()

public getCompletedSprints(int $groupId[, PageNavigation $sprintNav = null ]) : array<string|int, mixed>
Parameters
$groupId : int
$sprintNav : PageNavigation = null
Return values
array<string|int, mixed>

getCompletedStoryPointsMap()

public getCompletedStoryPointsMap(float $sumStoryPoints, array<string|int, mixed> $mapCompletedTasks, array<string|int, mixed> $itemsStoryPoints) : array<string|int, mixed>
Parameters
$sumStoryPoints : float
$mapCompletedTasks : array<string|int, mixed>
$itemsStoryPoints : array<string|int, mixed>
Return values
array<string|int, mixed>

getCompletedTasksMap()

public getCompletedTasksMap(SprintRanges $sprintRanges, TaskService $taskService, array<string|int, mixed> $completedTaskIds) : array<string|int, mixed>
Parameters
$sprintRanges : SprintRanges
$taskService : TaskService
$completedTaskIds : array<string|int, mixed>
Return values
array<string|int, mixed>

getDateEndFromLastPlannedSprint()

The method returns the end date of the last planned sprint.

public getDateEndFromLastPlannedSprint(int $groupId) : int|null
Parameters
$groupId : int

Group id.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
int|null

getErrorByCode()

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

getLastCompletedSprint()

Returns a last completed sprint by scrum group id.

public getLastCompletedSprint(int $groupId) : EntityForm
Parameters
$groupId : int

Scrum group id.

Return values
EntityForm

getPlannedSprints()

The method returns the planned sprints of the project.

public getPlannedSprints(int $groupId) : array<string|int, EntityForm>
Parameters
$groupId : int

Project id.

Return values
array<string|int, EntityForm>

getSprintData()

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

public getSprintData(EntityForm $sprint) : array<string|int, mixed>
Parameters
$sprint : EntityForm

Data object.

Return values
array<string|int, mixed>

getSprintsByGroupId()

Returns an array objects with sprints by scrum group id.

public getSprintsByGroupId(int $groupId) : array<string|int, EntityForm>
Parameters
$groupId : int

Scrum group id.

Return values
array<string|int, EntityForm>

getUncompletedSprints()

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

startSprint()

public startSprint(EntityForm $sprint, TaskService $taskService, KanbanService $kanbanService, ItemService $itemService, BacklogService $backlogService[, RobotService $robotService = null ][, PushService $pushService = null ]) : EntityForm
Parameters
$sprint : EntityForm
$taskService : TaskService
$kanbanService : KanbanService
$itemService : ItemService
$backlogService : BacklogService
$robotService : RobotService = null
$pushService : PushService = null
Return values
EntityForm 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results