org.llorllale.youtrack.api

Interface Comment

public interface Comment

A comment created on a YouTrack Issue.

Since:

0.2.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Instant	creationDate() The instant when the comment was created.
Issue	delete() Deletes this Comment from the Issue.
String	id() The comment's ID.
Issue	issue() The issue on which this comment was created.
String	text() The text content of the comment.
Comment	update(String text) Updates the text content of this Comment.

Method Detail

id

String id()

The comment's ID.

Returns:

the comment's ID

Since:

0.2.0

creationDate

Instant creationDate()

The instant when the comment was created.

Returns:

the instant when the comment was created

Since:

0.2.0

text

String text()

The text content of the comment.

Returns:

the text content of the comment

Since:

0.2.0

issue

Issue issue()

The issue on which this comment was created.

Returns:

the issue on which this comment was created

Since:

0.2.0

update

Comment update(String text)
        throws IOException,
               UnauthorizedException

Updates the text content of this Comment.

Parameters:

text - the new text

Returns:

this Comment, updated

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is unauthorized to perform this operation

Since:

0.9.0

delete

Issue delete()
      throws IOException,
             UnauthorizedException

Deletes this Comment from the Issue.

Note: deletion is not permanent; it is possible for an admin to restore a comment deleted with this operation.

Returns:

the parent Issue to which this comment belonged

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is unauthorized to perform this operation

Since:

0.9.0