Class ToponymObjectMetadata

Warning

This feature is available in the Full MapKit SDK version

Package com.yandex.mapkit.search

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

All Superinterfaces:

BaseMetadata

class ToponymObjectMetadata implements BaseMetadata, Serializable

Additional data for toponym objects.

Summary

Constructors

Signature and Description

ToponymObjectMetadata()
Use constructor with parameters in your code.

ToponymObjectMetadata(@NonNull Address address,
                      @Nullable Precision precision,
                      @Nullable java.lang.String formerName,
                      @NonNull Point balloonPoint,
                      int geoId,
                      @Nullable java.lang.String id)

Methods

Type and modifiers

Method and Description

synchronized Address

getAddress()
Structured toponym address

synchronized Precision

getPrecision()
Toponym precision.

synchronized java.lang.String

getFormerName()
Former name for toponym if any.

synchronized Point

getBalloonPoint()
Point where balloon for the toponym should be shown.

synchronized int

getGeoId()
geobase id

synchronized java.lang.String

getId()
Persistent toponym id (available for Yandex-owned regions).

void

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

static java.lang.String

getNativeName()

Constuctors

ToponymObjectMetadata

ToponymObjectMetadata()

Use constructor with parameters in your code.

This one is for serialization only!


ToponymObjectMetadata

ToponymObjectMetadata(@NonNull Address address,
                      @Nullable Precision precision,
                      @Nullable java.lang.String formerName,
                      @NonNull Point balloonPoint,
                      int geoId,
                      @Nullable java.lang.String id)

Methods

getAddress

@NonNull
Address getAddress()

Structured toponym address


getPrecision

@Nullable
Precision getPrecision()

Toponym precision.

Optional field, can be null.


getFormerName

@Nullable
java.lang.String getFormerName()

Former name for toponym if any.

Optional field, can be null.


getBalloonPoint

@NonNull
Point getBalloonPoint()

Point where balloon for the toponym should be shown.

Differs for direct and reverse search modes: Direct mode -- toponym center. Reverse mode -- toponym nearest point to the given coordinates.


getGeoId

int getGeoId()

geobase id


getId

@Nullable
java.lang.String getId()

Persistent toponym id (available for Yandex-owned regions).

Optional field, can be null.


serialize

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

getNativeName

java.lang.String getNativeName()

Previous
TimeRange
Next
ToponymResultMetadata