InterfaceOfOurOwn/com.soblemprolved.interfaceofourown.features.common.filterparameters/WorksFilterParameters

WorksFilterParameters

data class WorksFilterParameters(var showRatingGeneral: Boolean = true, var showRatingTeen: Boolean = true, var showRatingMature: Boolean = true, var showRatingExplicit: Boolean = true, var showRatingNotRated: Boolean = true, var includeWarningChoseNotToUseWarnings: Boolean = false, var includeWarningNone: Boolean = false, var includeWarningViolence: Boolean = false, var includeWarningCharacterDeath: Boolean = false, var includeWarningRape: Boolean = false, var includeWarningUnderage: Boolean = false, var excludeWarningChoseNotToUseWarnings: Boolean = false, var excludeWarningNone: Boolean = false, var excludeWarningViolence: Boolean = false, var excludeWarningCharacterDeath: Boolean = false, var excludeWarningRape: Boolean = false, var excludeWarningUnderage: Boolean = false, var includeCategoryGen: Boolean = false, var includeCategoryFM: Boolean = false, var includeCategoryFF: Boolean = false, var includeCategoryMM: Boolean = false, var includeCategoryMulti: Boolean = false, var includeCategoryOther: Boolean = false, var excludeCategoryGen: Boolean = false, var excludeCategoryFM: Boolean = false, var excludeCategoryFF: Boolean = false, var excludeCategoryMM: Boolean = false, var excludeCategoryMulti: Boolean = false, var excludeCategoryOther: Boolean = false, var showSingleChapterWorksOnly: Boolean = false, var showCrossovers: Boolean? = null, var showCompletedWorks: Boolean? = null, var hitsMin: Int = -1, var hitsMax: Int = -1, var kudosMin: Int = -1, var kudosMax: Int = -1, var commentsMin: Int = -1, var commentsMax: Int = -1, var bookmarksMin: Int = -1, var bookmarksMax: Int = -1, var wordCountMin: Int = -1, var wordCountMax: Int = -1, var dateUpdatedMin: LocalDate? = null, var dateUpdatedMax: LocalDate? = null, var includedTags: MutableList<String> = mutableListOf(), var excludedTags: MutableList<String> = mutableListOf(), var searchTerm: String = "", var language: Language = Language.ALL, var sortCriterion: WorkSortCriterion = WorkSortCriterion.DATE_UPDATED) : AbstractMap<String, String>

Represents the parameters used to filter works when browsing works by tag. The default values match AO3's defaults.

Most parameters that appear in AO3's filter dialog appear here. The only exceptions are for ratings; the include/exclude rating options were merged together into one showRating for each rating, as it makes no sense to include and exclude ratings for works.

Additional parameters for filtering works are also available, and they will be marked as such in the documentation.

Constructors

WorksFilterParameters

constructor(showRatingGeneral: Boolean = true, showRatingTeen: Boolean = true, showRatingMature: Boolean = true, showRatingExplicit: Boolean = true, showRatingNotRated: Boolean = true, includeWarningChoseNotToUseWarnings: Boolean = false, includeWarningNone: Boolean = false, includeWarningViolence: Boolean = false, includeWarningCharacterDeath: Boolean = false, includeWarningRape: Boolean = false, includeWarningUnderage: Boolean = false, excludeWarningChoseNotToUseWarnings: Boolean = false, excludeWarningNone: Boolean = false, excludeWarningViolence: Boolean = false, excludeWarningCharacterDeath: Boolean = false, excludeWarningRape: Boolean = false, excludeWarningUnderage: Boolean = false, includeCategoryGen: Boolean = false, includeCategoryFM: Boolean = false, includeCategoryFF: Boolean = false, includeCategoryMM: Boolean = false, includeCategoryMulti: Boolean = false, includeCategoryOther: Boolean = false, excludeCategoryGen: Boolean = false, excludeCategoryFM: Boolean = false, excludeCategoryFF: Boolean = false, excludeCategoryMM: Boolean = false, excludeCategoryMulti: Boolean = false, excludeCategoryOther: Boolean = false, showSingleChapterWorksOnly: Boolean = false, showCrossovers: Boolean? = null, showCompletedWorks: Boolean? = null, hitsMin: Int = -1, hitsMax: Int = -1, kudosMin: Int = -1, kudosMax: Int = -1, commentsMin: Int = -1, commentsMax: Int = -1, bookmarksMin: Int = -1, bookmarksMax: Int = -1, wordCountMin: Int = -1, wordCountMax: Int = -1, dateUpdatedMin: LocalDate? = null, dateUpdatedMax: LocalDate? = null, includedTags: MutableList<String> = mutableListOf(), excludedTags: MutableList<String> = mutableListOf(), searchTerm: String = "", language: Language = Language.ALL, sortCriterion: WorkSortCriterion = WorkSortCriterion.DATE_UPDATED)

WorksFilterParameters

Constructors

Properties

Functions