jira.js
    Preparing search index...

    Function getPinnedComments

    • Returns all pinned to the issue comments.

      Parameters

      • client: Client
      • parameters: { issueIdOrKey: string }
        • issueIdOrKey: string

          Issue id or key

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              comment?: {
                  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;
              };
              pinnedBy?: string;
              pinnedDate?: string;
              [key: string]: unknown;
          }[],
      >