com.skobbler.ngx.versioning

Class SKVersioningManager

java.lang.Object

com.skobbler.ngx.versioning.SKVersioningManager

All Implemented Interfaces:

SKVersioningService

public final class SKVersioningManager
extends java.lang.Object
implements SKVersioningService

Handles operations related to map versions.

Version:

3.3.0

Method Summary

Modifier and Type	Method and Description
void	checkNewVersion(int timeoutInSeconds) Initiates a request to check if a new maps version is detected.
boolean	downloadMetaData(int versionNumber) Generates request to download the metadata.
static SKVersioningManager	getInstance()
int	getLocalMapVersion() Returns the current map version used locally. Before calling this method, make sure that [SKMaps.initializeSKMaps] or [SKMaps.initializeSKMaps] is called.
int[]	getLocalMapVersionArray() Return the list of map versions the user had installed, sorted from latest to oldest.
SKMapVersioningListener	getMapVersioningListener() Returns current SKMapVersioningListener
SKMetaDataListener	getMetaDataListener() Returns current SKMetaDataListener
int	getMetaDataStatus(int versionNumber) Checks the status for metadata.
java.util.List<SKVersionInformation>	getRemoteMapVersionList() Return an array of available map version on the server.
int	getRequestedMapVersion() Get the specific map version requested to be used.
SKVersionInformation	getSKVersionInformation(int versionNumber) Returns the information about a version
void	setMapVersioningListener(SKMapVersioningListener mapVersioningListener) Sets the update listener.
void	setMetaDataListener(SKMetaDataListener listener) Sets the listener for meta data.
void	setRequestedMapVersion(int requestedMapVersion) Set a specific map version an initialisation.
boolean	updateMapsVersion(int newVersion) Updates the maps to version.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SKVersioningManager getInstance()

updateMapsVersion

public boolean updateMapsVersion(int newVersion)

Description copied from interface: SKVersioningService

Updates the maps to version. Previous map versions will be deleted.

Before calling this method, make sure that [SKMaps.initializeSKMaps] or [SKMaps.initializeSKMaps] is called.

Specified by:

updateMapsVersion in interface SKVersioningService

Parameters:

newVersion - the new version maps to be updated

getLocalMapVersion

public int getLocalMapVersion()

Description copied from interface: SKVersioningService

Returns the current map version used locally.

Before calling this method, make sure that [SKMaps.initializeSKMaps] or [SKMaps.initializeSKMaps] is called.

Specified by:

getLocalMapVersion in interface SKVersioningService

Returns:

unsigned int map version YYYYMMDD

getLocalMapVersionArray

public int[] getLocalMapVersionArray()

Description copied from interface: SKVersioningService

Return the list of map versions the user had installed, sorted from latest to oldest. This list does not coincide with [.getRemoteMapVersionList], since that list contains available versions on the server. This method returns only the versions that were installed on the device and the first one is the current version.

Specified by:

getLocalMapVersionArray in interface SKVersioningService

Returns:

an int array containing the map versions the user had installed.

getRemoteMapVersionList

public java.util.List<SKVersionInformation> getRemoteMapVersionList()

Description copied from interface: SKVersioningService

Return an array of available map version on the server. The first object of the list is the latest version on the server. This list is updated when the user checks for new versions using checkNewVersion if new versions appeared since the last update. The array consists of elements of SKVersionInformation type. The versions for the maps can be accessed using the version property of SKVersionInformation objects.

Specified by:

getRemoteMapVersionList in interface SKVersioningService

Returns:

an array of [SKVersionInformation]

checkNewVersion

public void checkNewVersion(int timeoutInSeconds)

Description copied from interface: SKVersioningService

Initiates a request to check if a new maps version is detected.

Before calling this method, make sure that [SKMaps.initializeSKMaps] or [SKMaps.initializeSKMaps] is called.

Specified by:

checkNewVersion in interface SKVersioningService

Parameters:

timeoutInSeconds - number of seconds the library tries to download the version file from the server to see if there's a new version for the maps

downloadMetaData

public boolean downloadMetaData(int versionNumber)

Description copied from interface: SKVersioningService

Generates request to download the metadata. The [SKMetaDataListener.onMetaDataDownloadFinished] will be triggered when the medadata will be available.



Before calling this method, make sure that [SKMaps.initializeSKMaps] or [SKMaps.initializeSKMaps] is called.

Specified by:

downloadMetaData in interface SKVersioningService

Parameters:

versionNumber - version number that has to be downloaded. If it has value 0, will be used current version

Returns:

true if the download was started, otherwise false.

getMetaDataStatus

public int getMetaDataStatus(int versionNumber)

Description copied from interface: SKVersioningService

Checks the status for metadata.



Before calling this method, make sure that [SKMaps.initializeSKMaps] or [SKMaps.initializeSKMaps] is called.

Specified by:

getMetaDataStatus in interface SKVersioningService

Parameters:

versionNumber - version number that has to be tested. If it has value 0, will be used current version

Returns:

-1 - error, 0 - not exist, 1 - downloaded, 2 - downloading

setMetaDataListener

public void setMetaDataListener(SKMetaDataListener listener)

Description copied from interface: SKVersioningService

Sets the listener for meta data.

Specified by:

setMetaDataListener in interface SKVersioningService

getMetaDataListener

public SKMetaDataListener getMetaDataListener()

Description copied from interface: SKVersioningService

Returns current SKMetaDataListener

Specified by:

getMetaDataListener in interface SKVersioningService

Returns:

object which implemented SKMetaDataListener or SKMetaDataListener.EMPTY

setMapVersioningListener

public void setMapVersioningListener(SKMapVersioningListener mapVersioningListener)

Description copied from interface: SKVersioningService

Sets the update listener.

Specified by:

setMapVersioningListener in interface SKVersioningService

getMapVersioningListener

public SKMapVersioningListener getMapVersioningListener()

Description copied from interface: SKVersioningService

Returns current SKMapVersioningListener

Specified by:

getMapVersioningListener in interface SKVersioningService

Returns:

object which implemented SKMapVersioningListener or SKMapVersioningListener.EMPTY

getSKVersionInformation

public SKVersionInformation getSKVersionInformation(int versionNumber)

Description copied from interface: SKVersioningService

Returns the information about a version

Specified by:

getSKVersionInformation in interface SKVersioningService

Returns:

a SKVersionInformation object or null if there is no version for the versionNumber passed as a parameter

getRequestedMapVersion

public int getRequestedMapVersion()

Description copied from interface: SKVersioningService

Get the specific map version requested to be used.

Specified by:

getRequestedMapVersion in interface SKVersioningService

Returns:

setRequestedMapVersion

public void setRequestedMapVersion(int requestedMapVersion)

Description copied from interface: SKVersioningService

Set a specific map version an initialisation. This should be called before initialisation.

Specified by:

setRequestedMapVersion in interface SKVersioningService