addComment
Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !
Availability
- This routine is available starting with katl-commons 1.0.
- This routine is available for Jira server and cloud deployment options.
Syntax
addComment(issue, username, comment)
or
addComment(issue, username, comment, securityLevel)
New Parameter
Starting with sil engine 4.8.0.3, "dispatchEvent" parameter was added. It allows to trigger or not the issue commented event. (Just for server)
addComment(issue, username, comment, dispatchEvent)
or
addComment(issue, username, comment, securityLevel, dispatchEvent)
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. On the server version, the securityLevel can be a group or a role. On the cloud version, only project roles are accepted. |
| dispatchEvent | boolean | No | If set to false, the issue commented event will not be triggered. Default value is true. This parameter is available just on the server version. |
Return type
number
The returned number represents the id of the comment.
Example
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.
See also