CustomPlacesManager

class CustomPlacesManager : 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

CategoriesError

enum CategoriesError : Enum<CustomPlacesManager.CategoriesError>

CategoriesListener

interface CategoriesListener

InstalledCountriesListener

interface InstalledCountriesListener

InstallProgress

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

InstallProgressListener

interface InstallProgressListener

InstallResult

enum InstallResult : Enum<CustomPlacesManager.InstallResult>

InstallResultListener

interface InstallResultListener

Mode

enum Mode : Enum<CustomPlacesManager.Mode>

Task

class Task

Class responsible for cancelling the running operation it represents.

Functions

getCategories

fun getCategories(listener: CustomPlacesManager.CategoriesListener, executor: Executor? = null)

Provides list of categories of custom places.

getInstalledCountries

fun getInstalledCountries(listener: CustomPlacesManager.InstalledCountriesListener, executor: Executor? = null)

Provides list of countries with installed offline places.

getMode

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.

installOfflinePlaces

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.

installOfflinePlacesFromJson

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

Loads offline places from provided json string.

onContextDestroy

open override fun onContextDestroy()

setMode

fun setMode(mode: CustomPlacesManager.Mode)

Set mode: ONLINE or OFFLINE.

uninstallOfflinePlaces

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

Uninstalls offline places of the requested country.

updateInstalledPlaces

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.