Function: getCommentProperty()

function getCommentProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Defined in: src/server/api/issueComments.ts:29

Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to have permissions to read the comment.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ commentId: string; propertyKey: string; }	-
parameters.commentId	string	The comment from which the property will be returned.
parameters.propertyKey?	string	The key of the property to return.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>