TaskCommentApi
extends AbstractApi
in package
Manage comments on tasks within projects
Table of Contents
Methods
- create() : TaskComment|null
- Add Task Comment
- delete() : mixed
- Delete Task Comment
- get() : TaskComment|null
- Get Task Comment
- list() : ModelCollection
- List Task Comments
- update() : TaskComment|null
- Edit Task Comment
Methods
create()
Add Task Comment
public
create(int $projectId, int $taskId, array<string|int, mixed> $data) : TaskComment|null
Parameters
- $projectId : int
- $taskId : int
- $data : array<string|int, mixed>
-
string $data[text] Text comment
integer $data[timeSpent] Time spent on the task in seconds
Tags
Return values
TaskComment|nulldelete()
Delete Task Comment
public
delete(int $projectId, int $taskId, int $commentId) : mixed
Parameters
- $projectId : int
- $taskId : int
- $commentId : int
Tags
get()
Get Task Comment
public
get(int $projectId, int $taskId, int $commentId) : TaskComment|null
Parameters
- $projectId : int
- $taskId : int
- $commentId : int
Tags
Return values
TaskComment|nulllist()
List Task Comments
public
list(int $projectId, int $taskId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $taskId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit] Default: 25
integer $params[offset] Default: 0
Tags
Return values
ModelCollectionupdate()
Edit Task Comment
public
update(int $projectId, int $taskId, TaskComment $taskComment) : TaskComment|null
Parameters
- $projectId : int
- $taskId : int
- $taskComment : TaskComment