jira.js
    Preparing search index...

    Function getComments

    • Returns all comments for an issue. Results can be ordered by the 'created' field which means the date a comment was added.

      Parameters

      • client: Client
      • parameters: {
            expand?: string;
            issueIdOrKey: string;
            maxResults?: string;
            orderBy?: string;
            startAt?: string;
        }
        • Optionalexpand?: string

          Optional flags: renderedBody (provides body rendered in HTML)

        • issueIdOrKey: string

          Issue id or key

        • OptionalmaxResults?: string

          How many results on the page should be included. Defaults to 50.

        • OptionalorderBy?: string

          Ordering of the results

        • OptionalstartAt?: string

          The page offset, if not specified then defaults to 0

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              comments?: {
                  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;
              }[];
              maxResults?: number;
              startAt?: number;
              total?: number;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility