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

GetActiveDatasetListener

fun interface GetActiveDatasetListener

InstalledDatasetListener

fun interface InstalledDatasetListener

InstalledDatasetSourceFilter

enum InstalledDatasetSourceFilter : Enum<CustomPlacesManager.InstalledDatasetSourceFilter>

InstallProgress

data class InstallProgress(val loadedRecords: Int, val totalRecords: Int)

InstallProgressListener

interface InstallProgressListener

enum InstallResult : Enum<CustomPlacesManager.InstallResult>

InstallResultListener

interface InstallResultListener

enum Mode : Enum<CustomPlacesManager.Mode>

SetActiveDatasetListener

fun interface SetActiveDatasetListener

SetActiveDatasetResult

enum SetActiveDatasetResult : Enum<CustomPlacesManager.SetActiveDatasetResult>

class Task

Class responsible for cancelling the running operation it represents.

Properties

defaultDatasetId

val defaultDatasetId: String

Functions

addSearchIndexingListener

fun addSearchIndexingListener(listener: CustomPlacesSearchIndexingListener, executor: Executor? = null)

Add a CustomPlacesSearchIndexingListener to subscribe for indexing operations callbacks.

getActiveDatasets

fun getActiveDatasets(listener: CustomPlacesManager.GetActiveDatasetListener, executor: Executor? = null)

getInstalledDatasets

fun getInstalledDatasets(filter: CustomPlacesManager.InstalledDatasetSourceFilter, listener: CustomPlacesManager.InstalledDatasetListener, executor: Executor? = null)

fun getMode(): CustomPlacesManager.Mode

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

installCategoriesFromJson

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

Loads Custom Place Categories from provided json string.

installOfflineDatasets

fun installOfflineDatasets(datasets: List<String>, iso: String? = null, resultListener: CustomPlacesManager.InstallResultListener, progressListener: CustomPlacesManager.InstallProgressListener? = null, executor: Executor? = null): CustomPlacesManager.Task

installOfflinePlacesFromJson

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

Loads offline places from provided json string.

onContextDestroy

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

open override fun onContextDestroy()

removeSearchIndexingListener

fun removeSearchIndexingListener(listener: CustomPlacesSearchIndexingListener)

Remove a CustomPlacesSearchIndexingListener to unsubscribe from indexing operations callbacks.

setActiveDatasets

fun setActiveDatasets(datasets: List<String>, listener: CustomPlacesManager.SetActiveDatasetListener, executor: Executor? = null)

fun setMode(mode: CustomPlacesManager.Mode)

Set mode: ONLINE or OFFLINE.

uninstallOfflineDatasets

fun uninstallOfflineDatasets(datasets: List<String>, iso: String? = null, resultListener: CustomPlacesManager.InstallResultListener, executor: Executor? = null): CustomPlacesManager.Task

uninstallOfflineDatasetsFromCountry

fun uninstallOfflineDatasetsFromCountry(iso: String, resultListener: CustomPlacesManager.InstallResultListener, executor: Executor? = null): CustomPlacesManager.Task

updateInstalledDatasets

fun updateInstalledDatasets(resultListener: CustomPlacesManager.InstallResultListener, progressListener: CustomPlacesManager.InstallProgressListener? = null, executor: Executor? = null): CustomPlacesManager.Task

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