Class: CommentClient

CommentClient(jiraClient)

new CommentClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/comment'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

deleteCommentProperty(opts, callbackopt) → {Promise}

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:
Name Type Attributes Description
opts

The options passed in the request to the API.

Properties
Name Type Description
commentId

The id of the comment from which keys will be returned.
propertyKey

The key of the property to be edited.
callback <optional>

Called when the property has been retrieved.
Source:
Returns:

Resolved when the property has been retrieved.

Type
Promise

getCommentProperty(opts, callbackopt) → {Promise}

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:
Name Type Attributes Description
opts

The options passed in the request to the API.

Properties
Name Type Description
commentId

The id of the comment from which keys will be returned.
propertyKey

The key of the property to be edited.
callback <optional>

Called when the property has been retrieved.
Source:
Returns:

Resolved when the property has been retrieved.

Type
Promise

getCommentPropertyKeys(opts, callbackopt) → {Promise}

Returns the keys of all properties for the comment identified by the key or by the id.

Parameters:
Name Type Attributes Description
opts

The options passed in the request to the API.

Properties
Name Type Description
commentId

The id of the comment from which keys will be returned.
callback <optional>

Called when the keys have been retrieved.
Source:
Returns:

Resolved when the keys have been retrieved.

Type
Promise

setCommentProperty(opts, callbackopt) → {Promise}

Sets the value of the specified comment's property.

You can use this resource to store a custom data against the comment identified by the key or by the id. The user who stores the data is required to have permissions to administer the comment.

Parameters:
Name Type Attributes Description
opts

The options passed in the request to the API.

Properties
Name Type Description
commentId

The id of the comment from which keys will be returned.
propertyKey

The key of the property to be edited.
propertyValue

The new value of the property.
callback <optional>

Called when the property has been edited.
Source:
Returns:

Resolved when the property has been edited.

Type
Promise