Interface Comment

A comment.

interface Comment {
    author?: UserDetails;
    body?: unknown;
    created?: string;
    id?: string;
    jsdAuthorCanSeeRequest?: boolean;
    jsdPublic?: boolean;
    properties?: EntityProperty[];
    renderedBody?: string;
    self?: string;
    updateAuthor?: UserDetails;
    updated?: string;
    visibility?: Visibility;
}

Hierarchy

  • Record<string, unknown>
    • Comment

Properties

author? body? created? id? jsdAuthorCanSeeRequest? jsdPublic? properties? renderedBody? self? updateAuthor? updated? visibility?

Properties

Optionalauthor

author?: UserDetails

The ID of the user who created the comment.

Optionalbody

body?: unknown

The comment text in Atlassian Document Format.

Optionalcreated

created?: string

The date and time at which the comment was created.

Optionalid

id?: string

The ID of the comment.

OptionaljsdAuthorCanSeeRequest

jsdAuthorCanSeeRequest?: boolean

Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.

OptionaljsdPublic

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.

Optionalproperties

properties?: EntityProperty[]

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

OptionalrenderedBody

renderedBody?: string

The rendered version of the comment.

Optionalself

self?: string

The URL of the comment.

OptionalupdateAuthor

updateAuthor?: UserDetails

The ID of the user who updated the comment last.

Optionalupdated

updated?: string

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

Optionalvisibility

visibility?: Visibility

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

Settings

Member Visibility

On This Page

Properties