Loading...
Searching...
No Matches
com.navigine.idl.java.LocationListManager Class Referenceabstract

Class is used for downloading locations list from the server and providing it to the user. More...

Public Member Functions

abstract void addLocationListListener (LocationListListener listener)
 Method is used to add LocationListListener element which will notify about newly downloaded list of available locations.
 
abstract void removeLocationListListener (LocationListListener listener)
 Method is used for removing previously added LocationListListener class element.
 
abstract void updateLocationList ()
 Method is used to force reload location list.
 
abstract HashMap< Integer, LocationInfogetLocationList ()
 Method is used to get current location list LocationInfo.
 

Detailed Description

Class is used for downloading locations list from the server and providing it to the user.

Referenced from NavigineSdk.

Definition at line 17 of file LocationListManager.java.

Member Function Documentation

◆ addLocationListListener()

abstract void com.navigine.idl.java.LocationListManager.addLocationListListener ( LocationListListener listener)
abstract

Method is used to add LocationListListener element which will notify about newly downloaded list of available locations.

Note
Do not forget to remove listener if it is no longer needed!
Parameters
listenerСorresponding LocationListListener class.

Java code snippet:

// Add location list listener
locationListManager.addLocationListListener(locationListListener);
System.out.println("Added location list listener");

Kotlin code snippet:

// Add location list listener
manager.addLocationListListener(listener)
println("Added location list listener")

◆ getLocationList()

abstract HashMap< Integer, LocationInfo > com.navigine.idl.java.LocationListManager.getLocationList ( )
abstract

Method is used to get current location list LocationInfo.

Returns
dictionary {location_id -> location_info}

Java code snippet:

// Get current location list
Map<Integer, LocationInfo> currentLocationList = locationListManager.getLocationList();
System.out.println("Current location list contains " + currentLocationList.size() + " locations");
demonstrateLocationList(currentLocationList);

Kotlin code snippet:

// Get current location list
val currentLocationList = manager.getLocationList()
println("Current location list contains ${currentLocationList.size} locations")
demonstrateLocationList(currentLocationList)

◆ removeLocationListListener()

abstract void com.navigine.idl.java.LocationListManager.removeLocationListListener ( LocationListListener listener)
abstract

Method is used for removing previously added LocationListListener class element.

Parameters
listenerСorresponding LocationListListener class to remove.

Java code snippet:

// Remove location list listener
locationListManager.removeLocationListListener(locationListListener);
System.out.println("Removed location list listener");

Kotlin code snippet:

// Remove location list listener
manager.removeLocationListListener(listener)
println("Removed location list listener")

◆ updateLocationList()

abstract void com.navigine.idl.java.LocationListManager.updateLocationList ( )
abstract

Method is used to force reload location list.

Java code snippet:

// Force reload location list
locationListManager.updateLocationList();
System.out.println("Requested location list update");

Kotlin code snippet:

// Force reload location list
manager.updateLocationList()
println("Requested location list update")

The documentation for this class was generated from the following file: