Interface Comment

A comment.

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

Hierarchy (view full)

Properties

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

Properties

Optional author

author?: Version3.Version3Models.UserDetails

Optional body

body?: Document

The comment text in Atlassian Document Format.

Optional created

created?: string

The date and time at which the comment was created.

Optional id

id?: string

The ID of the comment.

Optional jsdAuthorCanSeeRequest

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.

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?: Version3.Version3Models.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?: Version3.Version3Models.UserDetails

Optional updated

updated?: string

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

Optional visibility

visibility?: Version3.Version3Models.Visibility

Settings

Member Visibility

Theme

On This Page

authorbodycreatedidjsdAuthorCanSeeRequestjsdPublicpropertiesrenderedBodyselfupdateAuthorupdatedvisibility