Class SearchMetadata

com.yandex.mapkit.search

java.lang.Object ⇽ SearchMetadata

public class SearchMetadata

Additional info for search response;.

Constructors

SearchMetadata()

Use constructor with parameters in your code.

SearchMetadata(int found, @NonNull DisplayType displayType, @Nullable BoundingBox boundingBox, @Nullable Sort sort, @Nullable GeoObject toponym, @Nullable ToponymResultMetadata toponymResultMetadata, @Nullable BusinessResultMetadata businessResultMetadata, @NonNull String reqid, @NonNull String context, @NonNull String requestText, @Nullable String correctedRequestText, @Nullable BoundingBox requestBoundingBox)

Methods

synchronized BoundingBox getBoundingBox()

Bounding box of the response as a whole.

synchronized BusinessResultMetadata getBusinessResultMetadata()

Additional info for the response from organization search.

synchronized String getContext()

Server-generated request context.

synchronized String getCorrectedRequestText()

Initial request text with correction of spelling mistakes.

synchronized DisplayType getDisplayType()

Display type.

synchronized int getFound()

Approximate number of found objects.

String getNativeName()
synchronized String getReqid()

Server-generated request ID.

synchronized BoundingBox getRequestBoundingBox()

Initial request bounding box.

synchronized String getRequestText()

Initial request text.

synchronized Sort getSort()

Server-chosen sorting.

synchronized GeoObject getToponym()

Geocoder response to the toponym part of the query.

synchronized ToponymResultMetadata getToponymResultMetadata()

Additional info for the response from toponym search.

void serialize(Archive archive)

Constructor Detail

SearchMetadata

public SearchMetadata ()

Use constructor with parameters in your code.

This one is for serialization only!

SearchMetadata

public SearchMetadata (int found, @NonNull DisplayType displayType, @Nullable BoundingBox boundingBox, @Nullable Sort sort, @Nullable GeoObject toponym, @Nullable ToponymResultMetadata toponymResultMetadata, @Nullable BusinessResultMetadata businessResultMetadata, @NonNull String reqid, @NonNull String context, @NonNull String requestText, @Nullable String correctedRequestText, @Nullable BoundingBox requestBoundingBox)

Method Detail

getBoundingBox

public synchronized BoundingBox getBoundingBox ()

Bounding box of the response as a whole.

Optional field, can be null.

getBusinessResultMetadata

public synchronized BusinessResultMetadata getBusinessResultMetadata ()

Additional info for the response from organization search.

Optional field, can be null.

getContext

public synchronized String getContext ()

Server-generated request context.

getCorrectedRequestText

public synchronized String getCorrectedRequestText ()

Initial request text with correction of spelling mistakes.

Optional field, can be null.

getDisplayType

public synchronized DisplayType getDisplayType ()

Display type.

getFound

public synchronized int getFound ()

Approximate number of found objects.

getNativeName

public static String getNativeName ()

getReqid

public synchronized String getReqid ()

Server-generated request ID.

getRequestBoundingBox

public synchronized BoundingBox getRequestBoundingBox ()

Initial request bounding box.

Optional field, can be null.

getRequestText

public synchronized String getRequestText ()

Initial request text.

getSort

public synchronized Sort getSort ()

Server-chosen sorting.

Optional field, can be null.

getToponym

public synchronized GeoObject getToponym ()

Geocoder response to the toponym part of the query.

Optional field, can be null.

getToponymResultMetadata

public synchronized ToponymResultMetadata getToponymResultMetadata ()

Additional info for the response from toponym search.

Optional field, can be null.

serialize

public void serialize (Archive archive)