com.tomtom.online.sdk.search.extensions

Class SearchService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

com.tomtom.online.sdk.search.extensions.SearchService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, RxSearchApi, SearchApi

public class SearchService
extends android.app.Service
implements SearchApi

TomTom Search API wrapped within Android service. It contains methods to use Tomtom's online search engine and it provides support for both: standard callback calls and RxJava2 Observables. It allows to create a single search instance across an application.

Field Summary

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface com.tomtom.online.sdk.search.SearchApi

DEFAULT_ONLINE_SEARCH_ENDPOINT, DEFAULT_ONLINE_SEARCH_SERVICE_API_VERSION

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
SearchService()

Method Summary

Modifier and Type	Method and Description
Single<AlongRouteSearchResponse>	alongRouteSearch(AlongRouteSearchQuery query) Performs reactive search along route action based on provided query object and returns the result to Observers subscribed to returned Observable.
void	alongRouteSearch(AlongRouteSearchQuery query, AlongRouteSearchResultListener listener) Performs along route search action based on provided query object and returns the result with usage of callback implementation.
void	cancelSearchIfRunning() Cancels all current search requests.
Single<GeometrySearchResponse>	geometrySearch(GeometrySearchQuery query) Performs reactive geometry search action based on provided GeometrySearchQuery object and returns the result to Observers subscribed to returned Single.
void	geometrySearch(GeometrySearchQuery query, GeometrySearchResultListener listener) Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.
boolean	isInternetAvailable() Checks if the internet is available.
android.os.IBinder	onBind(android.content.Intent intent)
int	onStartCommand(android.content.Intent intent, int flags, int startId)
Single<ReverseGeocoderSearchResult>	reverseGeocoding(ReverseGeocoderSearchQuery query) Performs reactive reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result to Observers subscribed to returned Single.
void	reverseGeocoding(ReverseGeocoderSearchQuery query, RevGeoSearchResultListener listener) Performs reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result with usage of RevGeoSearchCallback implementation.
Single<FuzzySearchResponse>	search(FuzzySearchQuery searchQuery) Performs reactive search action based on provided FuzzySearchQuery object and returns the result to Observers subscribed to returned Observable.
void	search(FuzzySearchQuery searchQuery, FuzzySearchResultListener listener) Performs search action based on provided FuzzySearchQuery object and returns the result with usage of FuzzySearchResultListener implementation.

Methods inherited from class android.app.Service

dump, getApplication, onConfigurationChanged, onCreate, onDestroy, onLowMemory, onRebind, onStart, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchService

public SearchService()

Method Detail

onStartCommand

public int onStartCommand(android.content.Intent intent,
                          int flags,
                          int startId)

Overrides:

onStartCommand in class android.app.Service

onBind

@Nullable
public android.os.IBinder onBind(android.content.Intent intent)

Specified by:

onBind in class android.app.Service

search

public void search(FuzzySearchQuery searchQuery,
                   FuzzySearchResultListener listener)

Description copied from interface: SearchApi

Performs search action based on provided FuzzySearchQuery object and returns the result with usage of FuzzySearchResultListener implementation.

Specified by:

search in interface SearchApi

Parameters:

searchQuery - The object which contains data necessary to execute search action.

listener - The listener which informs the subscriber when search result is available. It contains FuzzySearchResponse object.

reverseGeocoding

public void reverseGeocoding(ReverseGeocoderSearchQuery query,
                             RevGeoSearchResultListener listener)

Description copied from interface: SearchApi

Performs reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result with usage of RevGeoSearchCallback implementation.

Specified by:

reverseGeocoding in interface SearchApi

Parameters:

query - The object which contains data necessary to execute search action

listener - The listener which informs the subscriber when search result is available. It contains ReverseGeocoderSearchResult object

geometrySearch

public void geometrySearch(GeometrySearchQuery query,
                           GeometrySearchResultListener listener)

Description copied from interface: SearchApi

Performs geometry search action based on provided GeometrySearchQuery object and returns the result with usage of GeometrySearchResultListener implementation.

Specified by:

geometrySearch in interface SearchApi

Parameters:

query - The object which contains data necessary to execute search action

listener - The listener which informs the subscriber when search result is available. It contains Response object

alongRouteSearch

public void alongRouteSearch(AlongRouteSearchQuery query,
                             AlongRouteSearchResultListener listener)

Description copied from interface: SearchApi

Performs along route search action based on provided query object and returns the result with usage of callback implementation.

Specified by:

alongRouteSearch in interface SearchApi

Parameters:

query - The object which contains data necessary to execute search action.

listener - The callback which informs the subscriber when search result is available.

isInternetAvailable

public boolean isInternetAvailable()

Description copied from interface: SearchApi

Checks if the internet is available.

Specified by:

isInternetAvailable in interface SearchApi

Returns:

true if device is online, false otherwise.

cancelSearchIfRunning

public void cancelSearchIfRunning()

Description copied from interface: SearchApi

Cancels all current search requests.

Specified by:

cancelSearchIfRunning in interface SearchApi

search

public Single<FuzzySearchResponse> search(FuzzySearchQuery searchQuery)

Description copied from interface: RxSearchApi

Performs reactive search action based on provided FuzzySearchQuery object and returns the result to Observers subscribed to returned Observable.

Specified by:

search in interface RxSearchApi

Parameters:

searchQuery - Object which contains data necessary to execute search action

Returns:

FuzzySearchResponse's Observable object.

reverseGeocoding

public Single<ReverseGeocoderSearchResult> reverseGeocoding(ReverseGeocoderSearchQuery query)

Description copied from interface: RxSearchApi

Performs reactive reverse geocoding search action based on provided ReverseGeocoderSearchQueryBuilder object and returns the result to Observers subscribed to returned Single.

Specified by:

reverseGeocoding in interface RxSearchApi

Parameters:

query - The object which contains data necessary to execute search action

Returns:

ReverseGeocoderSearchResult's Single object.

geometrySearch

public Single<GeometrySearchResponse> geometrySearch(GeometrySearchQuery query)

Description copied from interface: RxSearchApi

Performs reactive geometry search action based on provided GeometrySearchQuery object and returns the result to Observers subscribed to returned Single.

Specified by:

geometrySearch in interface RxSearchApi

Parameters:

query - The object which contains data necessary to execute search action

Returns:

com.tomtom.online.sdk.search.data.geometry.response.Response's Single object.

alongRouteSearch

public Single<AlongRouteSearchResponse> alongRouteSearch(AlongRouteSearchQuery query)

Description copied from interface: RxSearchApi

Performs reactive search along route action based on provided query object and returns the result to Observers subscribed to returned Observable.

Specified by:

alongRouteSearch in interface RxSearchApi

Parameters:

query - Object which contains data necessary to execute search action

Returns:

Search response's Observable object.