Function: getCommentContentProperties()

function getCommentContentProperties(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/contentProperties.ts:900

Retrieves Content Properties attached to a specified comment.

Permissions required: Permission to view the comment.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ commentId: number; cursor?: string; key?: string; limit?: number; sort?: "key" | "-key"; }	-
parameters.commentId	number	The ID of the comment for which content properties should be returned.
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.key?	string	Filters the response to return a specific content property with matching key (case sensitive).
parameters.limit?	number	Maximum number of attachments 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?	"key" | "-key"	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[]; }>