org.schabi.newpipe.extractor.comments

Interface CommentsInfoItemExtractor

All Superinterfaces:

InfoItemExtractor

All Known Implementing Classes:

BandcampCommentsInfoItemExtractor, PeertubeCommentsInfoItemExtractor, SoundcloudCommentsInfoItemExtractor, YoutubeCommentsInfoItemExtractor

public interface CommentsInfoItemExtractor
extends InfoItemExtractor

Method Summary

Modifier and Type	Method and Description
default String	getCommentId()
default String	getCommentText() The text of the comment
default int	getLikeCount() Return the like count of the comment, or CommentsInfoItem.NO_LIKE_COUNT if it is unavailable.
default Page	getReplies() The continuation page which is used to get comment replies from.
default int	getStreamPosition() The playback position of the stream to which this comment belongs.
default String	getTextualLikeCount() The unmodified like count given by the service It may be language dependent
default String	getTextualUploadDate() The upload date given by the service, unmodified
default DateWrapper	getUploadDate() The upload date wrapped with DateWrapper class
default String	getUploaderAvatarUrl()
default String	getUploaderName()
default String	getUploaderUrl()
default boolean	isHeartedByUploader() Whether the comment has been hearted by the uploader
default boolean	isPinned() Whether the comment is pinned
default boolean	isUploaderVerified() Whether the uploader is verified by the service

Methods inherited from interface org.schabi.newpipe.extractor.InfoItemExtractor

getName, getThumbnailUrl, getUrl

Method Detail

getLikeCount

default int getLikeCount()
                  throws ParsingException

Return the like count of the comment, or CommentsInfoItem.NO_LIKE_COUNT if it is unavailable.
NOTE: Currently only implemented for YT YoutubeCommentsInfoItemExtractor.getLikeCount() with limitations (only approximate like count is returned)

Returns:

the comment's like count or CommentsInfoItem.NO_LIKE_COUNT if it is unavailable

Throws:

ParsingException

See Also:

StreamExtractor.getLikeCount()

getTextualLikeCount

default String getTextualLikeCount()
                            throws ParsingException

The unmodified like count given by the service
It may be language dependent

Throws:

ParsingException

getCommentText

default String getCommentText()
                       throws ParsingException

The text of the comment

Throws:

ParsingException

getTextualUploadDate

default String getTextualUploadDate()
                             throws ParsingException

The upload date given by the service, unmodified

Throws:

ParsingException

See Also:

StreamExtractor.getTextualUploadDate()

getUploadDate

@Nullable
default DateWrapper getUploadDate()
                                     throws ParsingException

The upload date wrapped with DateWrapper class

Throws:

ParsingException

See Also:

StreamExtractor.getUploadDate()

getCommentId

default String getCommentId()
                     throws ParsingException

Throws:

ParsingException

getUploaderUrl

default String getUploaderUrl()
                       throws ParsingException

Throws:

ParsingException

getUploaderName

default String getUploaderName()
                        throws ParsingException

Throws:

ParsingException

getUploaderAvatarUrl

default String getUploaderAvatarUrl()
                             throws ParsingException

Throws:

ParsingException

isHeartedByUploader

default boolean isHeartedByUploader()
                             throws ParsingException

Whether the comment has been hearted by the uploader

Throws:

ParsingException

isPinned

default boolean isPinned()
                  throws ParsingException

Whether the comment is pinned

Throws:

ParsingException

isUploaderVerified

default boolean isUploaderVerified()
                            throws ParsingException

Whether the uploader is verified by the service

Throws:

ParsingException

getStreamPosition

default int getStreamPosition()
                       throws ParsingException

The playback position of the stream to which this comment belongs.

Throws:

ParsingException

See Also:

CommentsInfoItem.getStreamPosition()

getReplies

@Nullable
default Page getReplies()
                           throws ParsingException

The continuation page which is used to get comment replies from.

Returns:

the continuation Page for the replies, or null if replies are not supported

Throws:

ParsingException