org.everit.atlassian.restclient.jiracloud.v3.api

Class CommentPropertyApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.CommentPropertyApi

public class CommentPropertyApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CommentPropertyApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteCommentProperty(String commentId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete comment property Deletes a comment property.
io.reactivex.Single<EntityProperty>	getCommentProperty(String commentId, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get comment property Returns the value of a comment property.
io.reactivex.Single<PropertyKeys>	getCommentPropertyKeys(String commentId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get comment property keys Returns the keys of all the properties of a comment.
io.reactivex.Single<Object>	setCommentProperty(String commentId, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set comment property Creates or updates the value of a property for a comment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommentPropertyApi

public CommentPropertyApi(org.everit.http.restclient.RestClient restClient)

Method Detail

deleteCommentProperty

public io.reactivex.Completable deleteCommentProperty(String commentId,
                                                      String propertyKey,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete comment property

Deletes a comment property.

Permissions required: either of:

• Edit All Comments project permission to delete a property from any comment.
• Edit Own Comments project permission to delete a property from a comment created by the user.

Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

Parameters:

commentId -

The ID of the comment.

(required)

propertyKey -

The key of the property.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getCommentProperty

public io.reactivex.Single<EntityProperty> getCommentProperty(String commentId,
                                                              String propertyKey,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get comment property

Returns the value of a comment property.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project.
• If issue-level security is configured, issue-level security permission to view the issue.
• If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

commentId -

The ID of the comment.

(required)

propertyKey -

The key of the property.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<EntityProperty>

getCommentPropertyKeys

public io.reactivex.Single<PropertyKeys> getCommentPropertyKeys(String commentId,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get comment property keys

Returns the keys of all the properties of a comment.

This operation can be accessed anonymously.

Permissions required:

• Browse projects project permission for the project.
• If issue-level security is configured, issue-level security permission to view the issue.
• If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters:

commentId -

The ID of the comment.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PropertyKeys>

setCommentProperty

public io.reactivex.Single<Object> setCommentProperty(String commentId,
                                                      String propertyKey,
                                                      Object body,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set comment property

Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: either of:

• Edit All Comments project permission to create or update the value of a property on any comment.
• Edit Own Comments project permission to create or update the value of a property on a comment created by the user.

Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

Parameters:

commentId -

The ID of the comment.

(required)

propertyKey -

The key of the property. The maximum length is 255 characters.

(required)

body - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>