Class PageResource
java.lang.Object
com.atlassian.confluence.tinymceplugin.rest.PageResource
REST resource to allowing the creation of a comment against Confluence content. This resource lives in the TinyMCE plugin
because it operates on Editor formatted comment content.
For retrieval of Comments see the resource com.atlassian.confluence.plugins.restapi.resources.ContentResource
or com.atlassian.confluence.plugins.mobile.rest.ContentResource
.
-
Constructor Summary
ConstructorDescriptionPageResource
(CommentService commentService, NotificationManager notificationManager, CommentRenderService commentRenderService, CaptchaManager captchaManager, FormatConverter converter, PageManager pageManager, PermissionManager permissionManager, com.atlassian.xwork.XsrfTokenGenerator tokenGenerator, DraftsTransitionHelper draftsTransitionHelper, HeartbeatManager heartbeatManager, Differ differ, UserChecker userChecker, CollaborativeEditingHelper collaborativeEditingHelper, com.atlassian.event.api.EventPublisher eventPublisher, StorageFormatCleaner storageFormatCleaner, LicenseService licenseService) -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
add
(Long contentId, Long parentCommentId, String html, boolean watch, boolean actions, String uuid, javax.servlet.http.HttpServletRequest req) Create a reply to to the identified comment.javax.ws.rs.core.Response
add
(Long contentId, String html, boolean watch, boolean actions, String uuid, javax.servlet.http.HttpServletRequest req) Create a top level comment on the identified content using the HTML supplied from the Editor.javax.ws.rs.core.Response
edit
(Long commentId, String html, boolean watch, boolean actions, javax.servlet.http.HttpServletRequest req) javax.ws.rs.core.Response
getDraftDiff
(Long contentId) javax.ws.rs.core.Response
getEditorContent
(Long contentId)
-
Constructor Details
-
PageResource
@Inject public PageResource(CommentService commentService, NotificationManager notificationManager, CommentRenderService commentRenderService, CaptchaManager captchaManager, FormatConverter converter, PageManager pageManager, PermissionManager permissionManager, com.atlassian.xwork.XsrfTokenGenerator tokenGenerator, DraftsTransitionHelper draftsTransitionHelper, HeartbeatManager heartbeatManager, Differ differ, UserChecker userChecker, CollaborativeEditingHelper collaborativeEditingHelper, com.atlassian.event.api.EventPublisher eventPublisher, StorageFormatCleaner storageFormatCleaner, LicenseService licenseService)
-
-
Method Details
-
getDraftDiff
-
getEditorContent
-
add
public javax.ws.rs.core.Response add(Long contentId, String html, boolean watch, boolean actions, String uuid, @Context javax.servlet.http.HttpServletRequest req) Create a top level comment on the identified content using the HTML supplied from the Editor.- Parameters:
contentId
- the id of the content to comment onhtml
- the editor formatted html.actions
- if true then include the comment actions in the returned comment- Returns:
- a
CommentResult
(or subclass depending on actions parameter) in the response.
-
add
public javax.ws.rs.core.Response add(Long contentId, Long parentCommentId, String html, boolean watch, boolean actions, String uuid, @Context javax.servlet.http.HttpServletRequest req) Create a reply to to the identified comment.- Parameters:
contentId
- the id of the content to comment onparentCommentId
- the id of the comment to be replied tohtml
- the editor formatted html.actions
- if true then include the comment actions in the returned comment- Returns:
- a
CommentResult
(or subclass depending on actions parameter) in the response.
-
edit
-