Options
All
  • Public
  • Public/Protected
  • All
Menu

A comment.

Hierarchy

  • Comment

Indexable

[key: string]: any

Index

Properties

Optional author

author: UserDetails

The ID of the user who created the comment.

Optional body

body: string

The comment text.

Optional created

created: string

The date and time at which the comment was created.

format

date-time

Optional id

id: string

The ID of the comment.

Optional jsdAuthorCanSeeRequest

jsdAuthorCanSeeRequest: boolean

Whether the comment is made by an outsider who is not part of the issue.

Optional jsdPublic

jsdPublic: boolean

Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.

Optional properties

properties: EntityProperty[]

A list of comment properties. Optional on create and update.

Optional renderedBody

renderedBody: string

The rendered version of the comment.

Optional self

self: string

The URL of the comment.

Optional updateAuthor

updateAuthor: UserDetails

The ID of the user who updated the comment last.

Optional updated

updated: string

The date and time at which the comment was updated last.

format

date-time

Optional visibility

visibility: Visibility

The group or role to which this comment is visible. Optional on create and update.

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc