public class CommentPropertyResource extends Object
Constructor and Description |
---|
CommentPropertyResource(CommentPropertyService commentPropertyService,
JiraAuthenticationContext authenticationContext,
JiraBaseUrls jiraBaseUrls,
I18nHelper i18n) |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
deleteProperty(String commentId,
String propertyKey)
Removes the property from the comment identified by the key or by the id.
|
javax.ws.rs.core.Response |
getPropertiesKeys(String commentId)
Returns the keys of all properties for the comment identified by the key or by the id.
|
javax.ws.rs.core.Response |
getProperty(String commentId,
String propertyKey)
Returns the value of the property with a given key from the comment identified by the key or by the id.
|
javax.ws.rs.core.Response |
setProperty(String commentId,
String propertyKey,
javax.servlet.http.HttpServletRequest request)
Sets the value of the specified comment's property.
|
public CommentPropertyResource(CommentPropertyService commentPropertyService, JiraAuthenticationContext authenticationContext, JiraBaseUrls jiraBaseUrls, I18nHelper i18n)
@ExperimentalApi public javax.ws.rs.core.Response getPropertiesKeys(String commentId)
commentId
- the comment from which keys will be returned.@ExperimentalApi public javax.ws.rs.core.Response setProperty(String commentId, String propertyKey, @Context javax.servlet.http.HttpServletRequest request)
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.
commentId
- the comment on which the property will be set.propertyKey
- the key of the comment's property. The maximum length of the key is 255 bytes.request
- the request containing value of the comment's property. The value has to a valid, non-empty JSON conforming
to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.@ExperimentalApi public javax.ws.rs.core.Response getProperty(String commentId, String propertyKey)
commentId
- the comment from which the property will be returned.propertyKey
- the key of the property to return.EntityPropertyBean
.@ExperimentalApi public javax.ws.rs.core.Response deleteProperty(String commentId, String propertyKey)
commentId
- the comment from which the property will be removed.propertyKey
- the key of the property to remove.Copyright © 2002-2019 Atlassian. All Rights Reserved.