jira.js
    Preparing search index...

    Function getComment

    • Returns a comment.

      This operation can be accessed anonymously.

      Permissions required:

      • Browse projects project permission for the project containing the comment.
      • If issue-level security is configured, issue-level security permission to view the issue.
      • If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (string & {} | "renderedBody")[];
            id: string;
            issueIdOrKey: string;
        }
        • Optionalexpand?: string | string[] | 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.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              author?: {
                  accountId?: string;
                  accountType?: string;
                  active?: boolean;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              body?: {
                  content: Record<string, any>[];
                  type: string & {} | "doc";
                  version: number;
                  [key: string]: unknown;
              };
              created?: Date;
              id?: string;
              jsdAuthorCanSeeRequest?: boolean;
              jsdPublic?: boolean;
              properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
              renderedBody?: string;
              self?: string;
              updateAuthor?: {
                  accountId?: string;
                  accountType?: string;
                  active?: boolean;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              updated?: Date;
              visibility?: {
                  identifier?: string
                  | null;
                  type?: "role" | "group" | string & {};
                  value?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility