HeadConfig

abstract class HeadConfig

Module configuration, enable and modify the behaviour of some features.

To use this class you need to create a new class and extend HeadConfig or use a kotlin object, then modify the required variables in init.

Sample usage

object: HeadConfig() {
   init {
      isRecentsAvailable = true
      isSearchAvailable = true
      ...
   }
}

Constructors

HeadConfig

constructor()

Properties

analyticsSettings

var analyticsSettings: Analytics.Settings?

Enable the recommended system, you can choose between collecting the whole information page or only the Tags.

bypassBehavior

var bypassBehavior: BypassBehavior

Change the behavior and look of the Cloudflare bypass system, default is BypassBehavior.Default.

customDecoders

var customDecoders: List<VideoDecoder>?

Declare custom video decoders, the Main app already supports:

directoryOrientation

var directoryOrientation: DirectoryModel.Orientation

Specify if the directory style needs to be VERTICAL for portraits, or HORIZONTAL for videos.

isCalendarEnabled

var isCalendarEnabled: Boolean

Enable the calendar feature, this will call HeadRepository.calendarList when the main app loads the "Today" section in Home, this also will be called when the user enters the Calendar Activity.

isCastEnabled

var isCastEnabled: Boolean

Enable cast feature if your module uses direct video links.

isDirectoryAvailable

var isDirectoryAvailable: Boolean

Enable the directory section, this will call HeadRepository.directoryPager when the user enters the directory section, this also could be called multiple times if HeadRepository.directoryFilters is used.

isNotifyRecentsEnabled

var isNotifyRecentsEnabled: Boolean

Enable recents notifications feature, if enabled the main app will call HeadRepository.lastRecents periodically in order to get the latest recents.

isRecentsAvailable

var isRecentsAvailable: Boolean

Enable the recents feature, this will call HeadRepository.recentsPager in order to get the latest recents.

isSearchAvailable

var isSearchAvailable: Boolean

Enable the search feature, this will call HeadRepository.searchPager every time a user uses the search feature, this can also include custom filters using HeadRepository.searchFilters.

isSearchSuggestionsAvailable

var isSearchSuggestionsAvailable: Boolean

Enable custom suggestions for the search feature, this will call HeadRepository.searchSuggestions every time an user writes a new query.

isSensitiveContent

var isSensitiveContent: Boolean

Hide the history of this module

reviewConfig

var reviewConfig: ReviewConfig?

Enable the review feature in the information page, you can decide to request a star based review, a written review, or both.

searchBarText

var searchBarText: String?

Set a custom message for the search bar, by default the Module name is used.

settingsPage

var settingsPage: SettingPage?

Specify a list of custom settings, an icon will be visible for the user to enter this settings, this settings will persist in the Main app even if the Module is uninstalled.