Важно

This feature is available in the Full MapKit SDK version

Package com.yandex.mapkit.search

Class BusinessFilter

java.lang.Object
    ↳ com.yandex.mapkit.search.BusinessFilter

class BusinessFilter implements Serializable

A filter that could be applied to search results.

Filters can be either boolean (that is Wi-Fi availability in a cafe) or enumerated (that is cuisine type in a restaurant). Enumerated filters support multiple selected values (OR-combined), to search, for example, for restaurants with Armenian or Georgian cuisine at once.

This class is used in two separate ways: server response contains all filters applicable to current search request and client can use some of these filters to get more specific results in the following search requests

Nested Class Summary

Modifier and Type

Interface

Description

static

BooleanValue

Value for boolean filters.

static

EnumValue

Value for enum filters.

static

RangeValue

Value for range filters.

static

DateValue

Value for date filters.

static

Values

Possible filter values.

Summary

Constructors

Signature and Description

BusinessFilter()
Use constructor with parameters in your code.

BusinessFilter(@NonNull java.lang.String id,
               @Nullable java.lang.String name,
               @Nullable java.lang.Boolean disabled,
               @Nullable Image iconLight,
               @Nullable Image iconDark,
               @Nullable java.lang.Boolean singleSelect,
               @NonNull Values values)

Methods

Type and modifiers

Method and Description

synchronized java.lang.String

getId()
Filter id.

synchronized java.lang.String

getName()
Human-readable filter name.

synchronized java.lang.Boolean

getDisabled()
The filter should not be used by the client, because filter is either used already (selected:true, disabled:true) or nothing would be found (selected:false, disabled:true).

synchronized Image

getIconLight()
Optional field, can be null.

synchronized Image

getIconDark()
Optional field, can be null.

synchronized java.lang.Boolean

getSingleSelect()
Only one of multiple available values should be selected.

synchronized Values

getValues()
Filter values.

void

serialize(com.yandex.runtime.bindings.Archive archive)

static java.lang.String

getNativeName()

Constuctors

BusinessFilter

BusinessFilter()

Use constructor with parameters in your code.

This one is for serialization only!


BusinessFilter

BusinessFilter(@NonNull java.lang.String id,
               @Nullable java.lang.String name,
               @Nullable java.lang.Boolean disabled,
               @Nullable Image iconLight,
               @Nullable Image iconDark,
               @Nullable java.lang.Boolean singleSelect,
               @NonNull Values values)


Methods

getId

@NonNull
java.lang.String getId()

Filter id.


getName

@Nullable
java.lang.String getName()

Human-readable filter name.

Optional field, can be null.


getDisabled

@Nullable
java.lang.Boolean getDisabled()

The filter should not be used by the client, because filter is either used already (selected:true, disabled:true) or nothing would be found (selected:false, disabled:true).

Optional field, can be null.


getIconLight

@Nullable
Image getIconLight()

Optional field, can be null.


getIconDark

@Nullable
Image getIconDark()

Optional field, can be null.


getSingleSelect

@Nullable
java.lang.Boolean getSingleSelect()

Only one of multiple available values should be selected.

Optional field, can be null.


getValues

@NonNull
Values getValues()

Filter values.


serialize

@Override
void serialize(com.yandex.runtime.bindings.Archive archive)


getNativeName

java.lang.String getNativeName()


Предыдущая
Следующая