Важно

This feature is available in the Full MapKit SDK version

Package com.yandex.mapkit.search

Class SearchMetadata

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

All Superinterfaces:

BaseMetadata

class SearchMetadata implements BaseMetadata, Serializable

Additional info for search response;

Summary

Constructors

Signature and Description

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 java.lang.String reqid,
               @NonNull java.lang.String context,
               @NonNull java.lang.String requestText,
               @Nullable java.lang.String correctedRequestText,
               @Nullable BoundingBox requestBoundingBox)

Methods

Type and modifiers

Method and Description

synchronized int

getFound()
Approximate number of found objects.

synchronized DisplayType

getDisplayType()
Display type.

synchronized BoundingBox

getBoundingBox()
Bounding box of the response as a whole.

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.

synchronized BusinessResultMetadata

getBusinessResultMetadata()
Additional info for the response from organization search.

synchronized java.lang.String

getReqid()
Server-generated request ID.

synchronized java.lang.String

getContext()
Server-generated request context.

synchronized java.lang.String

getRequestText()
Initial request text.

synchronized java.lang.String

getCorrectedRequestText()
Initial request text with correction of spelling mistakes.

synchronized BoundingBox

getRequestBoundingBox()
Initial request bounding box.

void

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

static java.lang.String

getNativeName()

Constuctors

SearchMetadata

SearchMetadata()

Use constructor with parameters in your code.

This one is for serialization only!


SearchMetadata

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


Methods

getFound

int getFound()

Approximate number of found objects.


getDisplayType

@NonNull
DisplayType getDisplayType()

Display type.


getBoundingBox

@Nullable
BoundingBox getBoundingBox()

Bounding box of the response as a whole.

Optional field, can be null.


getSort

@Nullable
Sort getSort()

Server-chosen sorting.

Optional field, can be null.


getToponym

@Nullable
GeoObject getToponym()

Geocoder response to the toponym part of the query.

Optional field, can be null.


getToponymResultMetadata

@Nullable
ToponymResultMetadata getToponymResultMetadata()

Additional info for the response from toponym search.

Optional field, can be null.


getBusinessResultMetadata

@Nullable
BusinessResultMetadata getBusinessResultMetadata()

Additional info for the response from organization search.

Optional field, can be null.


getReqid

@NonNull
java.lang.String getReqid()

Server-generated request ID.


getContext

@NonNull
java.lang.String getContext()

Server-generated request context.


getRequestText

@NonNull
java.lang.String getRequestText()

Initial request text.


getCorrectedRequestText

@Nullable
java.lang.String getCorrectedRequestText()

Initial request text with correction of spelling mistakes.

Optional field, can be null.


getRequestBoundingBox

@Nullable
BoundingBox getRequestBoundingBox()

Initial request bounding box.

Optional field, can be null.


serialize

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


getNativeName

java.lang.String getNativeName()


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