| Info |
|---|
|
- This routine is available starting with katl-commons 4.0.7.
- This routine is available for Jira server and cloud deployment options.
|
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | deleteComment(commentId_or_mode[, | |
...
|
tip |
|
Starting with sil engine 4.8.0.3, "dispatchEvent" parameter was added. It allows to trigger or not the issue comment deleted event. (Just for Server) |
| Alias | deleteComment(commentId, dispatchEvent) |
|
...
or
...
issue, dispatchEvent) | Pkg Usage | |
|
| Excerpt |
|---|
|
| Deletes a comment with the specified id, deletes the latest comment or deletes all comments from a given issue. |
Deletes a comment with the specified id, deletes the latest comment or deletes all comments from a given issue.
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
commentId_or_mode | Number or String | Yes | Either the comment id (if we use the routine with only one parameter) or one of the next, otherwise: | |
...
- "DELETE_LATEST" to delete the latest comment for the given issue |
|
...
- "DELETE_ALL" to delete all the comments for the given issue | issue key | String | No |
|
...
| IssueKey. Should be used only if the mode is "DELETE_LATEST" or "DELETE_ALL" |
|
...
...
On the server version, the issue key parameter is optional, while on the cloud version it is mandatory and the order of the parameters should be as follows:
(issueKey, commentId_or_mode)
dispatchEvent | Boolean | No | If set to false, the issue comment deleted event will not be triggered. Default value is true. |
|
| Note |
|---|
This parameter is available just on the server version. |
...
Number
The number of comments deleted.Example
| Code Block |
|---|
return deleteComment("DELETE_ALL", "TEST-1");
|
Deletes all comments from "TEST-1" and returns the number of comments deleted.
...
| Code Block |
|---|
return deleteComment("DELETE_ALL", "TEST-1", false);
|
Deletes all comments from "TEST-1" and returns the number of comments deleted. The issue comment deleted event will not be triggered.
...
Deletes the comment with id 12400 and returns "1" because only one comment was deleted. If If the comment cannot be deleted it will return "0".
...
Deletes the comment with id 12400 and returns "1" because only one comment was deleted. If If the comment cannot be deleted it will return "0". The The issue comment deleted event will not be triggered.
...
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = "jira_comment_routine" and space = currentSpace ( ) |
|---|
| labels | jiraarray_comment_routineroutines |
|---|
|