SearchSession class abstract

Interface denoting ongoing search session. Allows search cancellation and retry. For many request types allows further searches.

Implemented types

• Finalizable

Constructors

SearchSession()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancel() → void

Cancels the current request.

fetchNextPage(SearchSessionSearchListener searchListener) → void

Request the next page of search results. Ignored if the current request isn't ready. Will throw if called when {@link search.Session#hasNextPage()} is false.

hasNextPage() → bool

Check the availability of the next result page. Return True if there are more search results and one can call SearchSession.fetchNextPage, false otherwise.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resetSort() → void

Resets the sort if it was previously set (for example by SearchSession.setSortByDistance) for future resubmits.

resubmit(SearchSessionSearchListener searchListener) → void

Redo the last search with currently set values of search area, search options, filters, sort type and sort origin. Isn't applicable to reverse geosearch and URI resolving. Ignored it the current request is the first one; cancels current request otherwise.

retry(SearchSessionSearchListener searchListener) → void

Retries the last request. If there is an active request, it is cancelled.

setFilters(List<SearchBusinessFilter> filters) → void

setSearchArea(Geometry area) → void

Sets the search area for future resubmits. Supported geometry types: bounding box, polyline, polygon. Polygon is expected to be a search window: 4 points in outer ring (or 5 if last point is equal to first) and no inner rings.

setSearchOptions(SearchOptions searchOptions) → void

Set searchOptions for future resubmits.

setSortByDistance(Geometry origin) → void

Requests sorting by distance for future resubmits. Supported geometry types: point, polyline.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited