LocationManager Directory Reference

Directories
	dart
	java
	kotlin
	objc
	swift

Detailed Description

This directory contains comprehensive examples demonstrating the usage of the LocationManager module across different programming languages. The LocationManager is responsible for downloading and working with locations, including sublocations, categories, venues, zones, beacons, WiFi access points, and navigation graphs.

Overview

The LocationManager module provides functionality to:

• Download and manage locations from the server
• Work with location metadata (ID, version, name, description)
• Access sublocations within a location
• Manage categories for organizing location elements
• Handle venues, zones, beacons, and WiFi access points
• Work with navigation graphs and elevation data
• Monitor location updates and changes

Supported Languages

• Java: java/LocationManagerExample.java
• Kotlin: kotlin/LocationManagerExample.kt
• Objective-C: objc/LocationManagerExample.m
• Swift: swift/LocationManagerExample.swift
• Dart/Flutter: dart/location_manager_example.dart

Key Classes and Methods

LocationManager

• addLocationListener(listener) - Add location listener for notifications
• removeLocationListener(listener) - Remove location listener
• setLocationId(locationId) - Set location ID to load
• getLocationId() - Get current location ID
• setLocationUpdateInterval(interval) - Set update interval in seconds
• commitChanges() - Commit pending changes
• revertChanges() - Revert pending changes

Location

• getId() - Get location identifier
• getVersion() - Get location version
• getName() - Get location name
• getDescript() - Get location description
• getModified() - Check if location is modified
• getGraphTags() - Get available graph tags
• getElevationGraph(tag) - Get elevation graph by tag
• getCategories() - Get all categories
• getCategoryById(id) - Get category by ID
• getSublocations() - Get all sublocations
• getSublocationById(id) - Get sublocation by ID

Category

• getId() - Get category identifier
• getName() - Get category name

Sublocation

• getId() - Get sublocation identifier
• getName() - Get sublocation name
• getDescript() - Get sublocation description
• getCategoryId() - Get category ID
• getVenues() - Get venues list
• getZones() - Get zones list
• getBeacons() - Get beacons list
• getWifis() - Get WiFi access points list
• getEddystones() - Get Eddystone beacons list
• getGraph() - Get navigation graph

Venue

• getId() - Get venue identifier
• getName() - Get venue name
• getDescript() - Get venue description
• getCategoryId() - Get category ID
• getPoint() - Get venue coordinates

Zone

• getId() - Get zone identifier
• getName() - Get zone name
• getDescript() - Get zone description
• getCategoryId() - Get category ID
• getPolygon() - Get zone polygon points

Beacon

• getId() - Get beacon identifier
• getName() - Get beacon name
• getDescript() - Get beacon description
• getUuid() - Get beacon UUID
• getMajor() - Get beacon major value
• getMinor() - Get beacon minor value
• getPower() - Get beacon power
• getPoint() - Get beacon coordinates
• getStatus() - Get beacon status

Wifi

• getId() - Get WiFi identifier
• getName() - Get WiFi name
• getDescript() - Get WiFi description
• getBssid() - Get WiFi BSSID
• getSsid() - Get WiFi SSID
• getPoint() - Get WiFi coordinates
• getStatus() - Get WiFi status

Eddystone

• getId() - Get Eddystone identifier
• getName() - Get Eddystone name
• getDescript() - Get Eddystone description
• getNamespace() - Get Eddystone namespace
• getInstance() - Get Eddystone instance
• getUrl() - Get Eddystone URL
• getPoint() - Get Eddystone coordinates
• getStatus() - Get Eddystone status

Point

• getX() - Get X coordinate
• getY() - Get Y coordinate

Graph

• getVertices() - Get graph vertices
• getEdges() - Get graph edges

GraphVertex

• getId() - Get vertex identifier
• getPoint() - Get vertex coordinates

GraphEdge

• getId() - Get edge identifier
• getSourceId() - Get source vertex ID
• getTargetId() - Get target vertex ID
• getWeight() - Get edge weight

ElevationGraph

• getTag() - Get elevation graph tag
• getGraph() - Get elevation graph

TransmitterStatus

Enumeration with values:

• Active - Transmitter is active
• Inactive - Transmitter is inactive

Usage Instructions

Prerequisites

1. Ensure you have the Navigine SDK properly installed for your target platform
2. Set up your user hash and server configuration
3. Have access to a valid location ID

Basic Usage Pattern

1. Initialize the Navigine SDK
2. Get the LocationManager instance
3. Set up a LocationListener to handle location events
4. Set the location ID to load
5. Handle location data in the listener callbacks
6. Clean up resources when done

Example Structure

Each example demonstrates:

• SDK initialization
• LocationManager setup
• LocationListener implementation
• Location data access
• Sublocation and element exploration
• Resource cleanup

Important Notes

• Server URL: All examples use https://custom.navigine.com as the server URL
• User Hash: Replace USER-HASH-HERE with your actual user hash
• Location ID: Replace 12345 with a valid location ID from your CMS
• Error Handling: Examples include basic error handling for SDK operations
• Resource Management: Remember to remove listeners to prevent memory leaks
• Thread Safety: LocationListener callbacks are typically invoked on the UI thread

Language-Specific Features

Java

• Uses abstract classes and interfaces
• Implements LocationListener as an anonymous class
• Uses ArrayList for collections

Kotlin

• Uses nullable types and safe calls
• Implements LocationListener using object expression
• Uses Kotlin collections and extension functions

Objective-C

• Uses protocols for LocationListener
• Implements delegate pattern
• Uses NSArray for collections

Swift

• Uses optional types and guard statements
• Implements LocationListener using protocol conformance
• Uses Swift arrays and optionals

Dart/Flutter

• Uses nullable types and null-aware operators
• Implements LocationListener interface
• Uses Dart lists and async/await patterns

File Structure

examples/LocationManager/
├── README.md
├── java/
│   └── LocationManagerExample.java
├── kotlin/
│   └── LocationManagerExample.kt
├── objc/
│   └── LocationManagerExample.m
├── swift/
│   └── LocationManagerExample.swift
└── dart/
    └── location_manager_example.dart

Running the Examples

Java

javac -cp "path/to/navigine-sdk.jar" LocationManagerExample.java
java -cp ".:path/to/navigine-sdk.jar" LocationManagerExample

Kotlin

kotlinc -cp "path/to/navigine-sdk.jar" LocationManagerExample.kt -include-runtime -d LocationManagerExample.jar
java -jar LocationManagerExample.jar

Objective-C

clang -framework Foundation -framework NavigineSDK LocationManagerExample.m -o LocationManagerExample
./LocationManagerExample

Swift

swiftc -import-objc-header NavigineSDK-Bridging-Header.h LocationManagerExample.swift -o LocationManagerExample
./LocationManagerExample

Dart

dart run location_manager_example.dart

Troubleshooting

• SDK Not Found: Ensure the Navigine SDK is properly linked for your platform
• Location Not Loading: Verify your user hash and location ID are correct
• Listener Not Called: Check that the LocationListener is properly implemented
• Memory Leaks: Always remove listeners when they're no longer needed

Additional Resources

• Navigine SDK Documentation
• Platform-specific setup guides
• API reference documentation
• Community forums and support channels