addJSDComment (Power Scripts)

We've encountered an issue exporting this macro. Please try exporting again later.

Syntax	addJSDComment(issue, username, comment,isPublic, 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
isPublic	Boolean	No	“true” for public comment or “false” for internal comment, the default is "true"
dispatchEvent (deprecated)	Boolean	No	“true” if you want to dispatch the commentAdded event and “false” if not, the default is "true". In newer versions of Service Desk, the API responsible for this feature was deprecated, and Atlassian doesn't use this parameter in newer versions. Please don't use this property for this method.

Return Type

Number

The returned number represents the id of the comment.

Examples

Example 1

Use the following code to add a public comment to the current issue on behalf of the current user. The commentAdded event will be dispatched.

addJSDComment(key, currentUser(), "I have executed a transition.");

The same can also be achieved with the following script:

addJSDComment(key, currentUser(), "I have executed a transition.", true);

Example 2

Use the following code to add an internal comment to the current issue on behalf of the current user. The commentAdded event will be dispatched.

addJSDComment(key, currentUser(), "you can't see me", false);

The same can also be achieved with the following script:

addJSDComment(key, currentUser(), "you can't see me", false, true);

Example 3

Use the following code to add an internal comment to the current issue on behalf of the current user. The commentAdded event will not be dispatched.

addJSDComment(key, currentUser(), "you can't see me", false, false);

In the newer versions of Service Desk, the API responsible for the dispatchEvent attribute was deprecated, and Atlassian doesn't use this parameter in newer versions. Don't use this property for this method. This means you should not be using the last attribute, "false" in this example. Thus, your code should look like this: