Skip to content

Function: deleteCommentProperty() ​

ts
function deleteCommentProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Removes the property from the comment identified by the key or by the id. Ths user removing the property is required to have permissions to administer the comment.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ commentId: string; propertyKey: string; }-
parameters.commentIdstringThe comment from which the property will be removed.
parameters.propertyKey?stringThe key of the property to remove.
options?RequestOptions-

Returns ​

Promise<void>