Function: getInlineComments()

function getInlineComments(client, parameters?): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  results?: object[];
}>;

Defined in: src/v2/api/comment.ts:285

Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to view the content of the page and its corresponding space.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ bodyFormat?: "storage" | "atlas_doc_format"; cursor?: string; limit?: number; sort?: "created-date" | "-created-date" | "modified-date" | "-modified-date"; }	-
parameters.bodyFormat?	"storage" | "atlas_doc_format"	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
parameters.cursor?	string	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
parameters.limit?	number	Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
parameters.sort?	"created-date" | "-created-date" | "modified-date" | "-modified-date"	Used to sort the result by a particular field.

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; results?: object[]; }>