Package-level declarations

Types

Link copied to clipboard
sealed class BypassBehavior

Cloudflare Bypass settings

Link copied to clipboard

Represents a calendar day

Link copied to clipboard

Categories for items.

Link copied to clipboard
data class ChipItem(val text: String, val image: String? = null, val clickAction: ClickAction? = null)

Represents a chip in the list.

Link copied to clipboard
data class ChipsData(val list: List<ChipItem>) : ExtraData

Represents a list of chips.

Link copied to clipboard
data class ChoiceItem(val name: String, val value: String)

Represents a choice item in the single and multi choice setting

Link copied to clipboard
sealed class ClickAction

Click behaviour

Link copied to clipboard
data class CollectionData(val list: List<CollectionItem>) : ExtraData

Represents a collection of items with a title, optional image and an optional ClickAction.

Link copied to clipboard
data class CollectionItem(val text: String, val subtext: String? = null, val media: ImageMediaItem? = null, val clickAction: ClickAction? = null)

Represents an item in the collection.

Link copied to clipboard
sealed class DecodeResult

Base decode result

Link copied to clipboard

Bypass dialog style

Link copied to clipboard
sealed class DisplayType

Bypass display type

Link copied to clipboard
class ExternalVideoItem(val name: String, val link: String, val type: String? = null, val quality: VideoItem.Quality? = null) : VideoItem

Represents a video item in the source that need to be open with an external app

Link copied to clipboard
sealed class ExtraData

Base class for section data.

Link copied to clipboard
data class ExtraDirectoryRequest(val title: String, val payload: String?) : Parcelable

Extra directory request used to load HeadRepository.extraDirectoryPager

Link copied to clipboard
data class ExtraSection(val title: String, val dataFlow: Flow<ExtraData?>)

Represents a section with data

Link copied to clipboard
class FilterData(val key: String, val name: String, val filterType: FilterData.Type, val items: List<FilterItem>)

Represents a filter section, each one contains a list of options, the behavior is controlled by the filterType which change the options between a list of checkboxes and radio buttons, when the filters are applied by the user the app will detect the differences between the filters and will return only the changed sections.

Link copied to clipboard
data class FilterItem(val value: String, val name: String, val isDefault: Boolean = false)

Represents an option in the filter

Link copied to clipboard
class FilterRequest(val filters: List<FilterResult>)

Represents a filter request

Link copied to clipboard
class FilterResult(filterData: FilterData, val selected: List<FilterItem>)

Represents a FilterData with the selected FilterItem (s)

Link copied to clipboard
data class GalleryData(val list: List<MediaItem>) : ExtraData

Represents a gallery of images and/or videos without titles using default click behaviours:

Link copied to clipboard
class GalleryItem(val link: String, val isVideo: Boolean = false, val headers: Map<String, String>? = null) : SourceItem

Represents an item in the gallery

Link copied to clipboard

Represents a gallery with media

Link copied to clipboard
class HorizontalImageItem(val imageLink: String) : ImageMediaItem

Represents an horizontal image item.

Link copied to clipboard
sealed class ImageMediaItem : MediaItem

Base image media item

Link copied to clipboard

Layout type for the information page.

Link copied to clipboard
data class LinkData(val link: String, val isUserOpenable: Boolean = true)

Represents an openable link, if the link is a valid URL and isUserOpenable is set to true, the user can open the link in a web browser.

Link copied to clipboard
class LoginData(var baseUrl: String = "", var loginUrl: String = "", var desiredCookie: String = "") : Parcelable

Represents the login data used in LoginCookies

Link copied to clipboard
sealed class MediaItem

Base media item.

Link copied to clipboard
data class Music(var title: String, var link: String, var subtitle: String? = null)

Represents a music track.

Link copied to clipboard
data class MusicData(val list: List<Music>) : ExtraData

Represents a list of music tracks.

Link copied to clipboard
sealed class NotifyData

Base notify data

Link copied to clipboard
class Option(val directLink: String, val name: String? = null, val quality: VideoItem.Quality? = null, val headers: Map<String, String>? = null)

Option object containing the data for the decoded source

Link copied to clipboard
data class PagerData<Key : Any, Value : Any>(val pageSize: Int, val source: PagingSource<Key, Value>)

Pager data representing a PagingData

Link copied to clipboard
data class RankingData(@FloatRange(from = 0.0, to = 5.0) val stars: Double, val count: Int? = null)

Represents a ranking data

Link copied to clipboard
data class ReviewConfig(val starsState: ReviewConfig.State, val commentaryState: ReviewConfig.State, val singleReview: Boolean, val minRating: Double = 0.0, val commentaryMaxLength: Int = 150)

Data representing the review system configuration

Link copied to clipboard
data class ReviewResult(val starts: Double?, val commentary: String?)

Data representing the result of an user review

Link copied to clipboard
data class Section(val name: String, val settings: List<Setting<*>>)

Represents a section in the settings screen

Link copied to clipboard
data class SectionData(val title: String, val data: PagerData<*, DirectoryModel>)

Represents a custom section in home

Link copied to clipboard
sealed class Setting<T>

Base setting

Link copied to clipboard
data class SettingPage(val sections: List<Section>)

Represents the settings screen for the module

Link copied to clipboard
sealed class SourceData<T : SourceItem>

Base source data

Link copied to clipboard
sealed class SourceItem

Base source item

Link copied to clipboard
class Subtitle(val uri: Uri, val language: String, val type: Subtitle.Type) : Parcelable

Subtitle object for VideoItem

Link copied to clipboard
data class TextData(val text: String, val clickAction: ClickAction? = null) : ExtraData

Represents a text extra.

Link copied to clipboard
class VerticalImageItem(val imageLink: String) : ImageMediaItem

Represents a vertical image item.

Link copied to clipboard
abstract class VideoDecoder

Represents a video decoder

Link copied to clipboard
open class VideoItem(val name: String, val link: String, val type: String? = null, val quality: VideoItem.Quality? = null, val subtitles: List<Subtitle>? = null, val needDecoder: Boolean = true, val canDownload: Boolean = true, val payload: String? = null) : SourceItem

Represents a video item in the source

Link copied to clipboard
class VideoMediaItem(videoLink: String, val usePlayer: Boolean) : MediaItem

Represents a video item.

Link copied to clipboard
class VideoSource(items: Flow<List<VideoItem>>) : SourceData<VideoItem>

Represents a source with videos

Link copied to clipboard
class WebItem(val name: String, val link: String) : SourceItem

Represents the data used to open the web page

Link copied to clipboard
class WebSource(name: String, link: String) : SourceData<WebItem>

Represents a web page source

Link copied to clipboard
data class YoutubeData(val videoId: String) : ExtraData

Represents a youtube video.

Link copied to clipboard
class YoutubeItem(videoId: String) : MediaItem

Youtube media item for the built-in youtube player.

Functions

Link copied to clipboard

Convenience extension to create a flow based in a data object.