addComment
Syntax | addComment(issue, username, comment[, securityLevel, dispatchEvent]) | Package |
|
Alias |
| Pkg Usage |
|
Description
Posts a comment on the specified issue on behalf of the specified user. Returns a number representing the id of the comment.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
issue key | String | Yes | Key of the selected issue. |
user name | String | Yes | User name of the selected user. |
comment | String | Yes | Comment that will be posted on the selected issue. |
securityLevel | String | No | Security level of comment. Security level can be a group or a role. |
dispatchEvent | Boolean | No | If set to false, the issue commented event will not be triggered. Default value is true. |
Return Type
Number
The returned number represents the id of the comment.
Examples
Example 1
addComment(key, currentUser(), "I have executed a transition.");Adds a comment on the current issue, on behalf of the current user.
Example 2
addComment(key, currentUser(), "you can't see me", "Administrators");Adds a comment on the current issue, on behalf of the current user, viewable only by "Administrators".
Example 3
addComment(key, currentUser(), "you can't see me", "Administrators", false);Adds a comment on the current issue, on behalf of the current user, viewable only by "Administrators", that will not trigger the issue commented event.