org.schabi.newpipe.extractor.subscription

Class SubscriptionExtractor

java.lang.Object

org.schabi.newpipe.extractor.subscription.SubscriptionExtractor

Direct Known Subclasses:

SoundcloudSubscriptionExtractor, YoutubeSubscriptionExtractor

public abstract class SubscriptionExtractor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionExtractor.ContentSource
static class	SubscriptionExtractor.InvalidSourceException Exception that should be thrown when the input do not contain valid content that the extractor can parse (e.g.

Field Summary

Fields

Modifier and Type	Field and Description
protected StreamingService	service

Constructor Summary

Constructors

Constructor and Description
SubscriptionExtractor(StreamingService service, List<SubscriptionExtractor.ContentSource> supportedSources)

Method Summary

Modifier and Type	Method and Description
List<SubscriptionItem>	fromChannelUrl(String channelUrl) Reads and parse a list of SubscriptionItem from the given channel url.
List<SubscriptionItem>	fromInputStream(InputStream contentInputStream) Reads and parse a list of SubscriptionItem from the given InputStream.
List<SubscriptionItem>	fromInputStream(InputStream contentInputStream, String contentType) Reads and parse a list of SubscriptionItem from the given InputStream.
abstract String	getRelatedUrl() Returns an url that can help/guide the user to the file (or channel url) to extract the subscriptions.
List<SubscriptionExtractor.ContentSource>	getSupportedSources()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

service

protected final StreamingService service

Constructor Detail

SubscriptionExtractor

public SubscriptionExtractor(StreamingService service,
                             List<SubscriptionExtractor.ContentSource> supportedSources)

Method Detail

getSupportedSources

public List<SubscriptionExtractor.ContentSource> getSupportedSources()

getRelatedUrl

@Nullable
public abstract String getRelatedUrl()

Returns an url that can help/guide the user to the file (or channel url) to extract the subscriptions.

For example, in YouTube, the export subscriptions url is a good choice to return here.

fromChannelUrl

public List<SubscriptionItem> fromChannelUrl(String channelUrl)
                                      throws IOException,
                                             ExtractionException

Reads and parse a list of SubscriptionItem from the given channel url.

Throws:

SubscriptionExtractor.InvalidSourceException - when the channelUrl doesn't exist or is invalid

IOException

ExtractionException

fromInputStream

public List<SubscriptionItem> fromInputStream(@Nonnull
                                              InputStream contentInputStream)
                                       throws ExtractionException

Reads and parse a list of SubscriptionItem from the given InputStream.

Throws:

SubscriptionExtractor.InvalidSourceException - when the content read from the InputStream is invalid and can not be parsed

ExtractionException

fromInputStream

public List<SubscriptionItem> fromInputStream(@Nonnull
                                              InputStream contentInputStream,
                                              @Nonnull
                                              String contentType)
                                       throws ExtractionException

Reads and parse a list of SubscriptionItem from the given InputStream.

Throws:

SubscriptionExtractor.InvalidSourceException - when the content read from the InputStream is invalid and can not be parsed

ExtractionException