Interface Comment

All Superinterfaces:
PropertySupport

public interface Comment extends PropertySupport
A comment on a pull request or commit.
  • Method Details

    • getAnchor

      @Nonnull Optional<CommentThreadDiffAnchor> getAnchor()
      This is a short-hand for comment.getThread().getAnchor()
      Returns:
      the anchor associated with this comment's thread
      Since:
      5.0
    • getAuthor

      @Nonnull ApplicationUser getAuthor()
      Returns:
      the author of the comment
    • getComments

      @Nonnull List<Comment> getComments()
      Returns:
      the direct replies to the comment, or an empty list of there are none
    • getCreatedDate

      @Nonnull Date getCreatedDate()
      Returns:
      the date when the comment was originally created
      See Also:
    • getId

      long getId()
      Returns:
      the comment's ID, which is globally unique
    • getPermittedOperations

      @Nonnull Optional<CommentOperations> getPermittedOperations()
      Returns:
      the operations allowed by the current user. If not present then none are permitted
      Since:
      5.0
    • getResolvedDate

      @Nullable Date getResolvedDate()
      Returns:
      the date that the comment was resolved or null if not resolved.
      Since:
      6.7
    • getResolver

      @Nullable ApplicationUser getResolver()
      Retrieves the user who resolved the comment.
      Returns:
      the user who resolved the comment or null if not resolved
      Since:
      6.7
    • getSeverity

      @Nonnull CommentSeverity getSeverity()
      Returns:
      the severity for this comment
      Since:
      6.7
    • getState

      @Nonnull CommentState getState()
      Returns:
      the state for this comment
      Since:
      6.7
    • getText

      @Nonnull @RequiredString(size=32768) String getText()
      Returns:
      the raw text of the comment (limited to 32k)
    • getThread

      @Nonnull CommentThread getThread()
      Returns:
      the thread this comment is a part of
      Since:
      5.0
    • getUpdatedDate

      @Nonnull Date getUpdatedDate()
      Returns:
      the date of the last update
      See Also:
    • getVersion

      int getVersion()
      Returns:
      the current version of the comment
      See Also: