com.atlassian.confluence.content.service

Interface CommentService

All Known Implementing Classes:

DefaultCommentService

public interface CommentService

Service interface for manipulating Comments.

See Also:

Confluence Service Layer Documentation

Method Summary

Modifier and Type	Method and Description
CreateCommentCommand	newCreateCommentCommand(long pageId, long parentCommentId, String content) Deprecated. Since 5.6. Use newCreateCommentCommand(long, long, String, java.util.UUID).
CreateCommentCommand	newCreateCommentCommand(long pageId, long parentCommentId, String content, UUID submissionToken) Retrieve a command to add a new command to some content, threaded below some other comment.
CreateCommentCommand	newCreateCommentCommand(long pageId, String content) Deprecated. Since 5.6. Use newCreateCommentCommand(long, String, java.util.UUID)
CreateCommentCommand	newCreateCommentCommand(long pageId, String content, UUID submissionToken) Retrieve a command to create a new comment and add it to some content.
CreateCommentCommand	newCreateCommentFromEditorCommand(long pageId, long parentCommentId, String content) Deprecated. Since 5.6. Use newCreateCommentFromEditorCommand(long, long, String, java.util.UUID).
CreateCommentCommand	newCreateCommentFromEditorCommand(long pageId, long parentCommentId, String content, UUID submissionToken) Retrieve a command to add a new command to some content, threaded below some other comment.
CreateCommentCommand	newCreateCommentFromEditorCommand(long pageId, String content) Deprecated. Since 5.5. Use newCreateCommentFromEditorCommand(long, long, String, java.util.UUID) if you must.
DeleteCommentCommand	newDeleteCommentCommand(long commentId) Retrieve a command to delete an existing comment
EditCommentCommand	newEditCommentCommand(long commentId, String newContent) Retrieve a command to edit the contents of a comment.
EditCommentCommand	newEditCommentFromEditorCommand(long commentId, String newContent) Retrieve a command to edit the contents of a comment.

Method Detail

newDeleteCommentCommand

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

newCreateCommentCommand

@Deprecated
CreateCommentCommand newCreateCommentCommand(long pageId,
                                                         String content)

Deprecated. Since 5.6. Use newCreateCommentCommand(long, String, java.util.UUID)

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

newCreateCommentCommand

CreateCommentCommand newCreateCommentCommand(long pageId,
                                             String content,
                                             UUID submissionToken)

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

submissionToken - a unique identifier for the comment

Returns:

an appropriate command instance

Since:

5.6

newCreateCommentCommand

@Deprecated
CreateCommentCommand newCreateCommentCommand(long pageId,
                                                         long parentCommentId,
                                                         String content)

Deprecated. Since 5.6. Use newCreateCommentCommand(long, long, String, java.util.UUID).

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

newCreateCommentCommand

CreateCommentCommand newCreateCommentCommand(long pageId,
                                             long parentCommentId,
                                             String content,
                                             UUID submissionToken)

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

submissionToken - a unique identifier for the comment

Returns:

an appropriate command instance

Since:

5.6

newCreateCommentFromEditorCommand

@Deprecated
CreateCommentCommand newCreateCommentFromEditorCommand(long pageId,
                                                                   String content)

Deprecated. Since 5.5. Use newCreateCommentFromEditorCommand(long, long, String, java.util.UUID) if you must.

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

newCreateCommentFromEditorCommand

@Deprecated
CreateCommentCommand newCreateCommentFromEditorCommand(long pageId,
                                                                   long parentCommentId,
                                                                   String content)

Deprecated. Since 5.6. Use newCreateCommentFromEditorCommand(long, long, String, java.util.UUID).

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

newCreateCommentFromEditorCommand

CreateCommentCommand newCreateCommentFromEditorCommand(long pageId,
                                                       long parentCommentId,
                                                       String content,
                                                       UUID submissionToken)

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.

submissionToken - a unique identifier for the comment

Returns:

an appropriate command instance

Since:

5.6

newEditCommentFromEditorCommand

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

newEditCommentCommand

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