scanner-ble/no.nordicsemi.android.common.scanner/ScanFilterState

ScanFilterState

Represents the state of the scanner, including available filters and sorting options.

This interface provides methods to check if a filter is selected and to retrieve the active sorting comparator based on the currently selected sorting option.

Properties

activeSortingOption

abstract val activeSortingOption: SortingOption

The active sorting option.

dynamicFilters

abstract val dynamicFilters: List<Filter>

The list of filters that can be applied to the scanner results.

filter

abstract val filter: ConjunctionFilterScope.() -> Unit

The filter to be applied to all scan results.

isEmpty

abstract val isEmpty: Boolean

A flag indicating whether any dynamic filters or sorting options are selected.

scanResultFilter

abstract val scanResultFilter: (ScanResult) -> Boolean

A filter to be applied to each scan result after it has been filtered by the filter.

sortingOptions

abstract val sortingOptions: List<SortingOption>

The list of sorting options that can be applied to the results.

Functions

clear

abstract fun clear()

Clears all selected filters and sorting options.

isFilterSelected

abstract fun isFilterSelected(index: Int): Boolean

Checks if the filter at the given index is selected.

sortBy

abstract fun sortBy(sortingOption: SortingOption)

Sets the active sorting option.

toggleFilter

abstract fun toggleFilter(index: Int)

Toggles the selection state of the filter at the given index.