Function: getCommentsByIds()

function getCommentsByIds(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/issueComments.ts:28

Returns a paginated list of comments specified by a list of comment IDs.

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:

• Has 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, belongs to the group or has the role visibility is restricted to.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: | "properties" | string & object | "renderedBody" | ("properties" | string & object | "renderedBody")[]; ids: number[]; }	-
parameters.expand?	| "properties" | string & object | "renderedBody" | ("properties" | string & object | "renderedBody")[]	Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: - renderedBody Returns the comment body rendered in HTML. - properties Returns the comment's properties.
parameters.ids?	number[]	The list of comment IDs. A maximum of 1000 IDs can be specified.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>