Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleAvailability
  • 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)

Tip
titleNew 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)

...

Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

addComment(issue, username, comment[,

...

securityLevel, dispatchEvent])

Package

Alias

Pkg Usage

Description

Excerpt
hiddentrue
SPosts a comment on the specified issue on behalf of the specified user. Returns a number representing the id of the comment.

Posts a comment on the specified issue on behalf of the specified user. Returns a number representing the id of the comment.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

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.

...

...

This parameter is available just on the server version.

Return type

...

Return Type

Number

The returned number represents the id of the comment.  

...

Examples

Example 1

Code Block
addComment(key, currentUser(), "I have executed a transition.");

Adds a comment on the current issue, on behalf of the current user.

...

Code Block
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".

...

Code Block
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.

...

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "comment_routine" and space = currentSpace ( )
labelscommentarray_routineroutines