Issue Comment

To interact with issue comments, the issueNoteService object is defined.

The issue comment entity contains the following data:

class IssueNote {...}

Name	Data Type	Description
id	string	UUID of the comment
message	string	Content of the comment
authorId	string	UUID of the comment's author
issueId	string	UUID of the issue containing the comment

Methods for Working with Issue Comments

The following methods exist for working with the issue comment entity:

Creating an Issue Comment

issueNoteService.create(toCreate: IssueNote) => IssueNote

This method creates a comment for an issue and returns it. You need to provide the following values to the method:

Name	Data Type	Description
issueId	string	UUID of the issue where the comment will be created
message	string	Content of the comment

Editing an Issue Comment

issueNoteService.edit(toEdit IssueNote) => IssueNote

This method edits a comment for an issue and returns it. You need to provide the following values to the method:

Name	Data Type	Description
id	string	UUID of the issue comment
message	string	Content of the comment

Getting a List of All Comments for an Issue

issueNoteService.findAll({issueId}, {startPage}, {pageSize}) => Page<IssueNote>

This method returns an object with all comments for an issue. You need to provide the following values to the method:

Name	Data Type	Description
issueId	string	UUID of the issue to search in
startPage	number	Number of the requested page
pageSize	number	Page size

Getting an Issue Comment by UUID

issueNoteService.findById({issueNoteId}) => IssueNote

This method returns the comment for an issue with the specified UUID. You need to provide the following values to the method:

Name	Data Type	Description
issueNoteId	string	UUID of the issue comment

Getting the Number of Comments in an Issue

issueNoteService.countAll({issueId}) => number

This method returns the number of comments for an issue. You need to provide the following values to the method:

Name	Data Type	Description
issueId	string	UUID of the issue in which the number of comments will be counted

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.