com.atlassian.servicedesk.api.comment

Interface ServiceDeskCommentCreateParameters

@ExperimentalApi
public interface ServiceDeskCommentCreateParameters

Parameter to create a JIRA Service Desk's Comment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServiceDeskCommentCreateParameters.Builder

Method Summary

Modifier and Type	Method and Description
com.atlassian.jira.user.ApplicationUser	author()
Optional<String>	body() Optional text body of the Comment.
com.atlassian.jira.issue.Issue	issue()
boolean	publicComment() Required parameter to indicate the Comment's visibility.
List<com.atlassian.jira.issue.attachment.TemporaryAttachmentId>	temporaryAttachmentIds() Optional list temporary attachment ID's to associate with the Comment.

Method Detail

author

@Nonnull
com.atlassian.jira.user.ApplicationUser author()

Returns:

author who creates the Comment

issue

@Nonnull
com.atlassian.jira.issue.Issue issue()

Returns:

the Issue the Comment associated to

body

@Nonnull
Optional<String> body()

Optional text body of the Comment. Either of body() or temporaryAttachmentIds(), or both must be provided

Returns:

text body of the Comment. null is not provided

temporaryAttachmentIds

@Nonnull
List<com.atlassian.jira.issue.attachment.TemporaryAttachmentId> temporaryAttachmentIds()

Optional list temporary attachment ID's to associate with the Comment. Either of body() or temporaryAttachmentIds(), or both must be provided

JIRA manages a list of user's TemporaryAttachment's by user session, and will expire them once the session expired.

Returns:

list of temporary attachment IDs. Empty list if not provided

publicComment

boolean publicComment()

Required parameter to indicate the Comment's visibility. If set to true, the Comment is visible to Customers. Otherwise, the comment is internal, and is only visible to Agents or Unlicenced users

Returns:

true if public comment, false otherwise