org.llorllale.youtrack.api

Interface Comments

public interface Comments

API for comments on an Issue.

Since:

0.4.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Comments	post(String text) Creates a new Comment for this Issue.
Stream<Comment>	stream() A Stream with all comments for this Issue.
Comments	update(Comment comment, String text) Updates the text content of a Comment.

Method Detail

stream

Stream<Comment> stream()
                throws IOException,
                       UnauthorizedException

A Stream with all comments for this Issue.

Returns:

A Stream with all comments for this Issue.

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Session is unauthorized to access this resource

Since:

0.4.0

post

Comments post(String text)
       throws IOException,
              UnauthorizedException

Creates a new Comment for this Issue.

Parameters:

text - the comment's text

Returns:

this object

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0

update

Comments update(Comment comment,
                String text)
         throws IOException,
                UnauthorizedException

Updates the text content of a Comment.

Parameters:

comment - the Comment to update

text - the new text

Returns:

this object

Throws:

IOException - if the server is unavailable

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

Since:

0.4.0