Jira.js - Jira Cloud API library
    Preparing search index...

    Interface UpdateComment

    interface UpdateComment {
        author?: Version3Models.UserDetails;
        body?: string | Document;
        created?: string;
        expand?: string | string[] | ["renderedBody"];
        id: string;
        issueIdOrKey: string;
        jsdAuthorCanSeeRequest?: boolean;
        jsdPublic?: boolean;
        notifyUsers?: boolean;
        overrideEditableFlag?: boolean;
        properties?: Version3Models.EntityProperty[];
        renderedBody?: string;
        self?: string;
        updateAuthor?: Version3Models.UserDetails;
        updated?: string;
        visibility?: Version3Models.Visibility;
    }

    Hierarchy

    Index

    Properties

    author? body? created? expand? id issueIdOrKey jsdAuthorCanSeeRequest? jsdPublic? notifyUsers? overrideEditableFlag? properties? renderedBody? self? updateAuthor? updated? visibility?

    Properties

    author?: Version3Models.UserDetails

    Optionalbody

    body?: string | Document
    created?: string

    The date and time at which the comment was created.

    expand?: string | string[] | ["renderedBody"]

    Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

    id: string

    The ID of the comment.

    issueIdOrKey: string

    The ID or key of the issue.

    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.

    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.

    notifyUsers?: boolean

    Whether users are notified when a comment is updated.

    overrideEditableFlag?: boolean

    Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.

    properties?: Version3Models.EntityProperty[]

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

    renderedBody?: string

    The rendered version of the comment.

    self?: string

    The URL of the comment.

    updateAuthor?: Version3Models.UserDetails
    updated?: string

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

    visibility?: Version3Models.Visibility

    Settings

    Member Visibility

    On This Page

    Properties