sdk/com.sygic.sdk.places/CustomPlacesManager

CustomPlacesManager

class CustomPlacesManager : NativeMethodsReceiver, SygicContext.OnContextDestroyListener

The class manages custom places: sets offline places or online places mode, installs and unistalls offline places. Online places are stored in online services and loaded when they are shown on a map view. Offline places are downloaded from online services and stored in a device in advance, so they can be shown also when a device is offline.

Types

Link copied to clipboard
Link copied to clipboard
interface CategoriesListener
Link copied to clipboard
Link copied to clipboard
data class InstallProgress(val loadedRecords: Int, val totalRecords: Int)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Task

Class responsible for cancelling the running operation it represents.

Functions

Link copied to clipboard
@JvmOverloads
fun addSearchIndexingListener(listener: CustomPlacesSearchIndexingListener, executor: Executor? = null)

Add a CustomPlacesSearchIndexingListener to subscribe for indexing operations callbacks.

Link copied to clipboard
@JvmOverloads
fun getCategories(listener: CustomPlacesManager.CategoriesListener, executor: Executor? = null)

Provides list of categories of custom places.

Link copied to clipboard
@JvmOverloads
fun getInstalledCountries(listener: CustomPlacesManager.InstalledCountriesListener, executor: Executor? = null)

Provides list of countries with installed offline places.

Link copied to clipboard
fun getMode(): CustomPlacesManager.Mode

Get current mode: ONLINE or OFFLINE. Initialized to ONLINE mode.

Link copied to clipboard
fun installCategoriesFromJson(jsonStream: String, listener: CustomPlacesManager.InstallResultListener, executor: Executor? = null)

Loads Custom Place Categories from provided json string.

Link copied to clipboard
@JvmOverloads
fun installOfflinePlaces(iso: String, resultListener: CustomPlacesManager.InstallResultListener, progressListener: CustomPlacesManager.InstallProgressListener? = null, executor: Executor? = null): CustomPlacesManager.Task

Downloads and installs offline places of the requested country.

Link copied to clipboard
fun installOfflinePlacesFromJson(jsonStream: String, listener: CustomPlacesManager.InstallResultListener, executor: Executor? = null)

Loads offline places from provided json string.

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY])
open override fun onContextDestroy()
Link copied to clipboard
fun removeSearchIndexingListener(listener: CustomPlacesSearchIndexingListener)

Remove a CustomPlacesSearchIndexingListener to unsubscribe from indexing operations callbacks.

Link copied to clipboard
fun setMode(mode: CustomPlacesManager.Mode)

Set mode: ONLINE or OFFLINE.

Link copied to clipboard
@JvmOverloads
fun uninstallOfflinePlaces(iso: String, resultListener: CustomPlacesManager.InstallResultListener, executor: Executor? = null)

Uninstalls offline places of the requested country.

Link copied to clipboard
@JvmOverloads
fun updateInstalledPlaces(resultListener: CustomPlacesManager.InstallResultListener, progressListener: CustomPlacesManager.InstallProgressListener? = null, executor: Executor? = null): CustomPlacesManager.Task

Downloads and installs updates for offline places of all installed countries.