Summary: Methods | [Expand All]
public interface

CommentService

com.atlassian.confluence.content.service.CommentService
Known Indirect Subclasses

Class Overview

Service interface for manipulating Comments.

See Also

Summary

Public Methods
abstract CreateCommentCommand newCreateCommentCommand(long pageId, long parentCommentId, String content)
Retrieve a command to add a new command to some content, threaded below some other comment.
abstract CreateCommentCommand newCreateCommentCommand(long pageId, String content)
Retrieve a command to create a new comment and add it to some content.
abstract CreateCommentCommand newCreateCommentFromEditorCommand(long pageId, long parentCommentId, String content)
Retrieve a command to add a new command to some content, threaded below some other comment.
abstract CreateCommentCommand newCreateCommentFromEditorCommand(long pageId, String content)
Retrieve a command to create a new comment and add it to some content.
abstract DeleteCommentCommand newDeleteCommentCommand(long commentId)
Retrieve a command to delete an existing comment
abstract EditCommentCommand newEditCommentCommand(long commentId, String newContent)
Retrieve a command to edit the contents of a comment.
abstract EditCommentCommand newEditCommentFromEditorCommand(long commentId, String newContent)
Retrieve a command to edit the contents of a comment.

Public Methods

public abstract CreateCommentCommand newCreateCommentCommand (long pageId, long parentCommentId, String content)

Retrieve a command to add a new command to some content, threaded below some other comment. The parent comment must (obviously) be attached to the page provided

Parameters
pageId the ID of the AbstractPage to attach the comment to
parentCommentId the ID of the comment that is the parent of this comment in a thread
content the content of the comment
Returns
  • an appropriate command instance

public abstract CreateCommentCommand newCreateCommentCommand (long pageId, String content)

Retrieve a command to create a new comment and add it to some content. The content identified by the id parameter must be an instance of AbstractPage (i.e. a page or blog post.)

Parameters
pageId the ID of the AbstractPage to attach the comment to
content the content of the comment
Returns
  • an appropriate command instance

public abstract CreateCommentCommand newCreateCommentFromEditorCommand (long pageId, long parentCommentId, String content)

Retrieve a command to add a new command to some content, threaded below some other comment. The parent comment must (obviously) be attached to the page provided. This instance of a CreateCommentCommand expects the comment content to be in Confluence editor format, meaning it will be transformed automatically to storage format when the command is executed.

Parameters
pageId the ID of the AbstractPage to attach the comment to
parentCommentId the ID of the comment that is the parent of this comment in a thread
content the content of the comment in Confluence editor format.
Returns
  • an appropriate command instance

public abstract CreateCommentCommand newCreateCommentFromEditorCommand (long pageId, String content)

Retrieve a command to create a new comment and add it to some content. The content identified by the id parameter must be an instance of AbstractPage (i.e. a page or blog post.) This instance of a CreateCommentCommand expects the comment content to be in Confluence editor format, meaning it will be transformed automatically to storage format when the command is executed.

Parameters
pageId the ID of the AbstractPage to attach the comment to
content the content of the comment
Returns
  • an appropriate command instance

public abstract DeleteCommentCommand newDeleteCommentCommand (long commentId)

Retrieve a command to delete an existing comment

Parameters
commentId the ID of the comment to delete
Returns
  • an appropriate command instance

public abstract EditCommentCommand newEditCommentCommand (long commentId, String newContent)

Retrieve a command to edit the contents of a comment.

Parameters
commentId the id of the comment to edit
newContent the new body of the content
Returns
  • an appropriate command instance

public abstract EditCommentCommand newEditCommentFromEditorCommand (long commentId, String newContent)

Retrieve a command to edit the contents of a comment. The content of the comment must be in editor format.

Parameters
commentId the id of the comment to edit
newContent the new body of the content
Returns
  • an appropriate command instance