Class SuggestOptions

com.yandex.mapkit.search

java.lang.Object ⇽ SuggestOptions

public class SuggestOptions

Struct to fine-tune suggest request.

Constructors

SuggestOptions(int suggestTypes, @Nullable Point userPosition, boolean suggestWords)
SuggestOptions()

Use constructor with parameters in your code.

Methods

int getSuggestTypes()

The suggest type can be one of SuggestType values or their bitwise 'OR' combination.

boolean getSuggestWords()

Enable word-by-word suggestion items.

Point getUserPosition()

The server uses the user position to calculate the distance from the user to suggest results.

void serialize(Archive archive)
SuggestOptions setSuggestTypes(int suggestTypes)

See getSuggestTypes().

SuggestOptions setSuggestWords(boolean suggestWords)

See getSuggestWords().

SuggestOptions setUserPosition(@Nullable Point userPosition)

See getUserPosition().

Constructor Detail

SuggestOptions

public SuggestOptions (int suggestTypes, @Nullable Point userPosition, boolean suggestWords)

SuggestOptions

public SuggestOptions ()

Use constructor with parameters in your code.

This one is for bindings only!

Method Detail

getSuggestTypes

public int getSuggestTypes ()

The suggest type can be one of SuggestType values or their bitwise 'OR' combination.

If suggestType is not initialized, it means to use server-defined types.

getSuggestWords

public boolean getSuggestWords ()

Enable word-by-word suggestion items.

getUserPosition

public Point getUserPosition ()

The server uses the user position to calculate the distance from the user to suggest results.

Optional field, can be null.

serialize

public void serialize (Archive archive)

setSuggestTypes

public SuggestOptions setSuggestTypes (int suggestTypes)

See getSuggestTypes().

setSuggestWords

public SuggestOptions setSuggestWords (boolean suggestWords)

See getSuggestWords().

setUserPosition

public SuggestOptions setUserPosition (@Nullable Point userPosition)

See getUserPosition().