jira.js
    Preparing search index...

    Function updateComment

    • Updates an existing comment using its JSON representation.

      Parameters

      • client: Client
      • parameters: {
            body?: {
                author?: {
                    active?: boolean;
                    avatarUrls?: Record<string, string>;
                    displayName?: string;
                    emailAddress?: string;
                    key?: string;
                    name?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                body?: string;
                created?: string;
                id?: string;
                properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
                renderedBody?: string;
                self?: string;
                updateAuthor?: {
                    active?: boolean;
                    avatarUrls?: Record<string, string>;
                    displayName?: string;
                    emailAddress?: string;
                    key?: string;
                    name?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                updated?: string;
                visibility?: {
                    type?: "role"
                    | "group"
                    | string & {};
                    value?: string;
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            expand?: string;
            id: string;
            issueIdOrKey: string;
        }
        • Optionalbody?: {
              author?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              body?: string;
              created?: string;
              id?: string;
              properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
              renderedBody?: string;
              self?: string;
              updateAuthor?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              updated?: string;
              visibility?: {
                  type?: "role"
                  | "group"
                  | string & {};
                  value?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }
        • Optionalexpand?: string

          Optional flags: renderedBody (provides body rendered in HTML)

        • id: string

          Comment id

        • issueIdOrKey: string

          Issue id or key

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              author?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              body?: string;
              created?: string;
              id?: string;
              properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
              renderedBody?: string;
              self?: string;
              updateAuthor?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              updated?: string;
              visibility?: {
                  type?: "role"
                  | "group"
                  | string & {};
                  value?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >