Interface Comment

  • All Superinterfaces:
    UpdateTracking
    All Known Implementing Classes:
    ImmutableComment

    @Immutable
    public interface Comment
    extends UpdateTracking
    Pull Request Review Comments are comments on a portion of the unified diff. These are separate from Commit Comments Comment (which are applied directly to a commit, outside of the Pull Request view), and Issue Comments Comment (which do not reference a portion of the unified diff).
    • Method Detail

      • url

        @Nullable
        URI url()
        Comment API URL.
      • id

        @Nullable
        Long id()
        Comment id.
      • diffHunk

        @Nullable
        String diffHunk()
        Unified diff.
      • path

        @Nullable
        String path()
        The relative path of the file to comment on.
      • position

        @Nullable
        Integer position()
        The line index in the diff to comment on.
      • originalPosition

        @Nullable
        Integer originalPosition()
        Base content line position.
      • commitId

        @Nullable
        String commitId()
        The SHA of the commit to comment on.
      • originalCommitId

        @Nullable
        String originalCommitId()
        Base commit sha.
      • user

        @Nullable
        User user()
        Comment author.
      • body

        @Nullable
        String body()
        The text of the comment.
      • htmlUrl

        @Nullable
        URI htmlUrl()
        Comment URL.
      • pullRequestUrl

        @Nullable
        URI pullRequestUrl()
        Pull request API URL.