PHP Class Bitrix24\Task\CommentItem

Inheritance: extends Bitrix24\Bitrix24Entity
Show file Open project: mesilov/bitrix24-php-sdk

Public Methods

Method Description
add ( $taskId, $fields ) : array Creates a new comment to a task. Returns the identifier to the comment added.
delete ( $taskId, $commentItemId ) : array Delete a comment.
get ( $taskId, $commentItemId ) : array Returns comments to a task.
getList ( $taskId, $order, $filter ) : array Returns the list of comments to a task.
getManifest ( ) : array Returns the list of methods of the type task.commentitem.* and their description.
isActionAllowed ( $taskId, $commentItemId, $actionId ) : array Checks if the action is permitted.
update ( $taskId, $commentItemId, $fields ) : array Updates the comment data.

Method Details

add() public method

Creates a new comment to a task. Returns the identifier to the comment added.
See also: http://www.bitrixsoft.com/rest_help/tasks/task/commentitem/add.php
public add ( $taskId, $fields ) : array
$taskId integer Task identifier. Required parameter.
$fields array Data field array for a task (POST_MESSAGE). Required parameter.
return array

delete() public method

Delete a comment.
See also: http://www.bitrixsoft.com/rest_help/tasks/task/commentitem/delete.php
public delete ( $taskId, $commentItemId ) : array
$taskId integer Task identifier. Required parameter.
$commentItemId integer Comment identifier. Required parameter.
return array

get() public method

Returns comments to a task.
See also: http://www.bitrixsoft.com/rest_help/tasks/task/commentitem/get.php
public get ( $taskId, $commentItemId ) : array
$taskId integer Task identifier. Required parameter.
$commentItemId integer Comment identifier. Required parameter.
return array

getList() public method

Returns the list of comments to a task.
See also: http://www.bitrixsoft.com/rest_help/tasks/task/commentitem/getlist.php
public getList ( $taskId, $order, $filter ) : array
$taskId integer
$order array
$filter array
return array

getManifest() public method

Returns the list of methods of the type task.commentitem.* and their description.
See link: http://www.bitrixsoft.com/rest_help/tasks/task/commentitem/getmanifest.php
public getManifest ( ) : array
return array

isActionAllowed() public method

Checks if the action is permitted.
See also: http://www.bitrixsoft.com/rest_help/tasks/task/checklistitem/isactionallowed.php
public isActionAllowed ( $taskId, $commentItemId, $actionId ) : array
$taskId integer Task identifier. Required parameter.
$commentItemId integer Comment identifier. Required parameter.
$actionId integer Identifier of the action to be checked: 1 - ACTION_COMMENT_ADD; 2 - ACTION_COMMENT_MODIFY; 3 - ACTION_COMMENT_REMOVE. Required parameter.
return array

update() public method

Updates the comment data.
See also: http://www.bitrixsoft.com/rest_help/tasks/task/commentitem/update.php
public update ( $taskId, $commentItemId, $fields ) : array
$taskId integer Task identifier. Required parameter.
$commentItemId integer Comment identifier. Required parameter.
$fields array Data field array for a task (POST_MESSAGE). Required parameter.
return array