sdk/com.sygic.sdk.search

Package-level declarations

Types

open class AutocompleteResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox) : Result

AutocompleteResultListener

interface AutocompleteResultListener

CompositeSearch

class CompositeSearch : Search

Composite search engine (combination of any types of Search engines)

ContactDataAutocompleteResult

data class ~~ContactDataAutocompleteResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : AutocompleteResult, FlatDataPayload

ContactDataResult

data class ~~ContactDataResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : GeocodingResult, FlatDataPayload

CoordinateSearch

class CoordinateSearch : Search

Coordinate search engine (search input may look like this: "48.1457, 17.1269")

CreateSearchCallback

interface CreateSearchCallback<T : Search>

Callback interface for create search operation

CustomPlaceDataAutocompleteResult

data class ~~CustomPlaceDataAutocompleteResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : AutocompleteResult, FlatDataPayload

CustomPlaceDataResult

data class ~~CustomPlaceDataResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : GeocodingResult, FlatDataPayload

CustomPlacesSearch

class CustomPlacesSearch : Search

Custom places search engine (use com.sygic.sdk.places.CustomPlacesManager to install custom places)

FavoriteDataAutocompleteResult

data class ~~FavoriteDataAutocompleteResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : AutocompleteResult, FlatDataPayload

FavoriteDataResult

data class ~~FavoriteDataResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : GeocodingResult, FlatDataPayload

FlatAutocompleteResult

open class FlatAutocompleteResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox, val payload: Parcelable) : AutocompleteResult

FlatData

data class FlatData(val title: String, val subtitle: String, val location: GeoCoordinates, val payload: Parcelable) : Parcelable

FlatDataAutocompleteResult

data class ~~FlatDataAutocompleteResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox, val payload: Long) : AutocompleteResult

FlatDataPayload

interface ~~FlatDataPayload~~

FlatDataResult

open class ~~FlatDataResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val payload: Long) : GeocodingResult

FlatResult

open class FlatResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val payload: Parcelable) : GeocodingResult

FlatResultType

enum FlatResultType : Enum<FlatResultType> , Parcelable

FlatSearch

class FlatSearch : Search

Flat search engine (add your own flat data into search engine, data will not persist SDK restart and are valid only for single FlatSearch instance)

GeocodeLocationRequest

data class GeocodeLocationRequest @JvmOverloads constructor(val locationId: String)

GeocodingResult

open class GeocodingResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox) : Result

GeocodingResultListener

interface GeocodingResultListener

GeocodingResultsListener

interface GeocodingResultsListener

HistoryDataAutocompleteResult

data class ~~HistoryDataAutocompleteResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val locationId: String, val categoryTags: List<String>, val categoryBoundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : AutocompleteResult, FlatDataPayload

HistoryDataResult

data class ~~HistoryDataResult~~(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val flatType: FlatResultType, val payload: Parcelable) : GeocodingResult, FlatDataPayload

HouseNumberResult

data class HouseNumberResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val iso: String, val addressComponent: Map<MapResultComponent, String>, val entry: GeoCoordinates, val exactMatch: Boolean) : MapResult

MapResult

open class MapResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val iso: String, val addressComponent: Map<MapResultComponent, String>) : GeocodingResult

MapResultComponent

enum MapResultComponent : Enum<MapResultComponent> , Parcelable

Geocoding components.

OfflineMapSearch

class OfflineMapSearch : Search

Offline maps search engine (OfflineMapSearch consumes a lot of resources, it is recommended to share one OfflineMapSearch instance)

OnlineMapSearch

class OnlineMapSearch : Search

Online search engine (using online search API)

PlacePageRequest

data class PlacePageRequest @JvmOverloads constructor(val continuationToken: String)

Represents a request for a page of places.

PlaceRequest

data class PlaceRequest @JvmOverloads constructor(val location: GeoCoordinates, val categoryTags: List<String>, val radius: Int, val boundary: GeoBoundingBox? = null, val maxResultCount: Int = 10, val languageTag: String? = null)

Represents a request to find places (POIs) based on location and category.

PlaceResult

data class PlaceResult(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>, val location: GeoCoordinates, val boundary: GeoBoundingBox, val iso: String, val addressComponent: Map<MapResultComponent, String>, val entry: GeoCoordinates, val details: List<PlaceResultDetail>, val categoryTags: List<String>, val placeLink: PlaceLink) : MapResult

PlaceResultDetail

data class PlaceResultDetail(val key: String, val value: String) : Parcelable

PlacesListener

interface PlacesListener

Result

open class Result(val type: ResultType, val distance: Double, val title: String, val subtitle: String, val titleHighlights: List<StringRange>) : Parcelable

ResultNames

data class ResultNames : Parcelable

ResultStatus

enum ResultStatus : Enum<ResultStatus> , Parcelable

ResultType

enum ResultType : Enum<ResultType> , Parcelable

ReverseGeocoder

class ReverseGeocoder : SygicContext.OnContextDestroyListener

ReverseGeocodingResult

data class ReverseGeocodingResult : Parcelable

open class Search

Base class for search engines Allows creation of search sessions

SearchManager

class SearchManager : SygicContext.OnContextDestroyListener

SearchRequest

data class SearchRequest @JvmOverloads constructor(val searchInput: String, val location: GeoCoordinates, val maxResultCount: Int = 10, val boundary: GeoBoundingBox? = null, val languageTag: String? = null, val resultTypeFilter: List<ResultType>? = null, val countryIsoFilter: List<String>? = null)

Session

class Session

Session has a limited lifetime. The lifetime follows this call graph:

StringRange

data class StringRange(val from: Int, val size: Int) : Parcelable