Class Index - Steerpath SDK

A B C D E F G I L M N O R S T U W

A

Action Action of the Suggestion Query. 
AssetGateway Asset Gateway is used for tracking assets (Steerpath Asset Beacons) real time. 

B

BlueDotListener The listener interface for receiving user's approximate location updates. 
BluetoothScanner Created by opiirone on 14/11/2017. 
BluetoothServices Collection of Bluetooth related tools. 
BottomSheet Subclassable BottomSheet base class provides API for creating and updating the root View. 
BottomSheet.OnActionCallback Concrete BottomSheet may have a button or other UI element that triggers an action. 
BottomSheet.OnDetachCallback Callback to be invoked after BottomSheet has been detached from the parent CoordinatorLayout. 
BottomSheet.OnResultCallback<T> Use this callback definition if BottomSheet should produce some kind of outcome, that is supposedly passed to next BottomSheet. 
BottomSheetFactory Abstract Factory definition for building different kinds of BottomSheets. 
BottomSheetOptions<T> Abstract BottomSheetOptions. 
BottomSheetOptions.BottomSheetCallback Communication channel from concrete BottomSheet implementation to controller. 
BottomSheetProvider "Factory of Abstract Factories" that connects concrete BottomSheetFactory and concrete BottomSheetOptions. 

C

CompassCalibrationFragment DialogFragment that contains instructions for compass calibration. 
CompassUtils CompassUtils notifies if compass calibration is required. 
CompassUtils.Listener Invoked when sensor accuracy stawtus  

D

DefaultNextWaypointRouteOptionsFactory SDK's default route line appearance for "next route segment". 
DefaultRouteOptionsFactory SDK's default route line appearance. 
DefaultRoutePreviewOptionsFactory SDK's default route line appearance when in preview-mode. 
DeveloperOptions Developer mode for making developer's daily life slightly easier. 
DirectionsAdapter SDK's in-built RecyclerView.Adapter for displaying RouteSteps in a RecyclerView. 
DirectionsAdapter.OnRouteStepClickListener DirectionsAdapter-to-parent communication channel. 
DirectionsApi The Directions API is the main entry point to the directions subsystem of the Steerpath platform. 
DirectionsAssetHelper DirectionsAssetHelper.IconChooser chooses suitable DrawableRes for directions steps. 
DirectionsAssetHelper.DefaultChooser SDK's Default IconChooser for deciding which drawable should be shown for RouteStep. 
DirectionsAssetHelper.DefaultComposer SDK's default TextComposer for constructing user visible translations for RouteStep Actions. 
DirectionsAssetHelper.IconChooser Simple interface definition for choosing the icon for RouteStep. 
DirectionsAssetHelper.TextComposer Simple interface definition for composing directions instructions text. 
DirectionServices Access point to Directions API. 
DirectionsException Exception class used by the DirectionsListener to indicate one or more of the routes failed to be solved. 
DirectionsListener Used for obtaining the result of a directions query. 
DirectionsRequest A directions request describes the needed directions information. 
DirectionsRequest.Builder Used for creating new DirectionsRequest objects. 
DirectionsResponse A response describing the solutions found, i.e. 

E

EidUpdater Interface definition for mechanism that fetches necessary EID packages. 

F

FakeLocationSource LocationSource that publishes "fake location updates" once per second. 
Foreground Singleton that detects when app goes to background and foreground. 
Foreground.Listener The listener for receiving notification when app has been backgrounded or foregrounded. 
FusedLocationProviderApi The FusedLocationProviderApi provides a way to request location updates. 
FusedLocationSource The FusedLocationSource is an easy to use API for receiving location. 

G

Geofence Describes an area that can be monitored for entries and exits. 
Geofence.Builder Used for configuring and instantiating Geofence objects. 
GeofenceListener Implement this interface and register it as a listener in the GeofencingApi to receive notifications of GeofencingEvents. 
GeofencingApi The main API for interacting with the geofencing functionality. 
GeofencingEvent GeofencingEvents occur when a geofence has been registered and the conditions for it getting triggered are fulfilled. 
GeoJsonHelper Helpers and utils for Features and GeoJson. 
GuideOptions Runtime configuration options for indoor positioning engine. 

I

IndoorBuilding An IndoorBuilding represents a building on the map which has indoor maps, i.e. 
IndoorLevel An indoor level represents a floor in a building. 

L

LeScanCallback  
LiveMapOptions Use this class to configure SteerpathMapView settings to show live users on the map. 
LiveOptions Use this class to configure live settings for this user/device. 
LiveServiceLoginListener Gives callback whether login to SteerpathLive has succeeded or failed. 
LiveSpaceStatusResolver LiveSpaceStatusResolver fetches space occupancy information from the Steerpath Live. 
LiveSpaceStatusResolver.Space Space model object. 
LiveSpaceStatusResolver.SpaceStatusCallback Callback definition for receiving Room objects. 
LiveUser Data transfer object for SteerpathMapView Live events. 
LoaderError Describes what went wrong with your query. 
LocalizationHelper For example,RouteStepViewHolder may present following text: "take minibus to terminal" where general format is to
LocalizationHelper.DefaultTranslator DefaultTranslator can be subclassed. 
LocalizationHelper.Translator Simple interface definition for translating strings that are coming from the Steerpath backend instead of application resources. 
Location com.steerpath.sdk.location.Location has similar API than android.location.Location. 
LocationFactory Create new Location-objects with LocationFactory. 
LocationListener The listener interface for receiving Location updates. 
LocationProvider Steerpath LocationProvider is abstraction for "system providing user location data". 
LocationRequest A location request defines parameters for how accurate and how frequent location updates should be. 
LocationServices LocationServices is the main access point to Location API. 
LocationServices.EidQueryCallback The listener interface for receiving result of EID status queries. 
LocationSource A location source provides location updates to a listener through the LocationSource.OnLocationChangedListener object's onUpdate method. 
LocationSource.OnLocationChangedListener OnLocationChangedListener is used for receiving updates when a location changes. 
LocationTimeoutListener Implement this interface and register it as a listener in the FusedLocationProviderApi to receive notifications when location (gps/bluetooth) is lost. 

M

MapUtils Helpers and tools for SteerpathMapView and SteerpathMap. 
MapWidgetType Broadcast Intent keys to inform which BottomSheet (or other possible future widget) is currently shown in the SteerpathMapView. 
MapWidgetType.BottomSheetType  
MetaFeature MetaFeature is an object obtained from Steerpath Meta Service and parsed from GeoJson. 
MetaFeature.Builder Implements standard Builder for Feature. 
MetaFeatureFactory Builds MetaFeature-objects from GeoJSON. 
MetaFeatureParser GeoJson-to-MetaFeature parser interface. 
MetaLoader MetaLoader connects to Steerpath Web API and fetches GeoJSON based on given MetaQuery object. 
MetaLoader.InvalidMetaQueryException This exception will be thrown by MetaLoader if MetaQuery has illegal arguments. 
MetaLoader.LoadListener Callback for asynchronous load tasks. 
MetaQuery MetaQuery is used with Steerpath Web Services. 
MetaQuery.Builder Implements standard Builder for MetaQuery. 
MetaQuery.DataType Subtypes of meta data that can be fetched from the server. 
MetaQueryResult MetaQueryResult is a response from Steerpath Meta Service and contains raw GeoJson, parsed MetaFeatures and possible error messages. 

N

NavigationBottomSheet Concrete BottomSheet that used when SteerpathMapView is in navigation mode. 
NavigationBottomSheetOptions Concrete BottomSheetOptions that defines all necessary parameters for NavigationBottomSheet to operate. 
NavigationBottomSheetOptions.Event  
NavigationPreviewBottomSheet Concrete BottomSheet that used when SteerpathMapView is in navigation preview mode. 
NavigationPreviewBottomSheetOptions Concrete BottomSheetOptions that defines all necessary parameters for NavigationPreviewBottomSheet to operate. 

O

OfflineBundle Represent bundled offline data including NDD, route tiles, map tiles, configuration files, meta data and style. 
OfflineUpdater Interface for OfflineBundle installer/updater. 
OfflineUpdater.OfflineUpdateListener Callback for monitoring update progress. 
OnMapReadyCallback Interface definition for a callback to be invoked when the map is ready to be used. 
OnRouteStatusUpdate Interface for receiving updates from a RouteTracker instance. 

R

Route A route defines the directions from a source to a destination. 
RouteListener RouteListener is callback that is invoked in response to navigateTo(RoutePlan, RouteListener) and previewRoute(RoutePlan, RouteListener)
RouteOptionsFactory RouteOptionsFactory provides customization options for route rendering. 
RouteOptionsFactory.LineRenderMode  
RouteOptionsFactory.MarkerRenderMode  
RouteOptionsFactory.RenderMode  
RouteOptionsFactory.RouteLineMode  
RoutePlan RoutePlan mainly describes origin and the destination of route, but provides also configuration options for navigation behaviour and appearance of the route line. 
RoutePlan.Builder Implements standard Builder for RoutePlan. 
RouteStep A route is made up out of steps describing what actions a user needs to take to follow the route. 
RouteStep.Action  
RouteTrackerProgress Instances of this class describe the progress on the tracked route. 
RouteUtils Route helpers. 

S

SdkNotStartedException Thrown if SteerpathClient is not actually started and Service or feature with direct or indirect dependency to SteerpathClient has been invoked. 
SdkNotStartedRuntimeException Thrown if SteerpathClient is not actually started and Service or feature with direct or indirect dependency to SteerpathClient has been invoked. 
SteerpathAnnotation Base class for SteerpathMarkerView, SteerpathMarker, SteerpathPolygon and SteerpathPolyline
SteerpathAnnotationOptions AnnotationOptions is extension to BaseMarkerViewOptions, BaseMarkerOptions, PolylineOptions and PolygonOptions. 
SteerpathAnnotationOptions.Builder Implements standard Builder for SteerpathAnnotationOptions. 
SteerpathClient Main entry point to the SDK. 
SteerpathClient.OfflineBundleStartListener Extension of StarListener that notifies earliest point when app can show map view. 
SteerpathClient.ServiceRegion  
SteerpathClient.StartConfig Configuration options for the SDK. 
SteerpathClient.StartConfig.Builder Implements standard Builder for StartConfig. 
SteerpathClient.StartListener Callback for notifying when SteerpathClient has started. 
SteerpathGeofence Created by virkkila on 14/08/16. 
SteerpathLayer The purpose of SteerpathLayer is mainly to satisfy SteerpathAnnotation API; i.e Steerpath SDK can treat Layers in the same manner than BaseMarkerOptions, BaseMarkerViewOptions, PolygonOptions and PolylineOptions. 
SteerpathLayerOptions Wraps Mapbox Layer and Filter. 
SteerpathLayerOptions.BaseFilter  
SteerpathMap The SteerpathMap is the controller for the SteerpathMapView. 
SteerpathMap.BlueDotMode List of different blue dot behavior modes. 
SteerpathMap.MapMode List of different map behavior modes. 
SteerpathMap.OnIndoorStateChangeListener With this listener, application may listen when focused building and level changes. 
SteerpathMapFragment SteerpathMapFragment is a wrapper for SteerpathMapView. 
SteerpathMapFragment.MapViewListener SteerpathMapFragment-to-Activity communication channel. 
SteerpathMapOptions Initialize SteerpathMapFragment with SteerpathMapOptions. 
SteerpathMapView The SteerpathMapView extends the MapView provided by Mapbox in order to implement features that relate to indoor positoning. 
SteerpathMapView.LiveUsersListener The listener interface for receiving list of Steerpath Live users. 
SteerpathMapView.LocateMeButtonListener Application may interrupt LocateMe-button clicks with this callback. 
SteerpathMapView.LocateMeButtonMode  
SteerpathMapView.OnPermissionsNotGrantedListener OnMissingPermissionsListener notifies if runtime permission are not granted and it blocks usage of SteerpathMapView. 
SteerpathMarker Wraps com.mapbox.mapboxsdk.annotations.Marker  
SteerpathMarkerView Wraps com.mapbox.mapboxsdk.annotations.MarkerView  
SteerpathPolygon Wraps com.mapbox.mapboxsdk.annotations.Polygon  
SteerpathPolyline Wraps com.mapbox.mapboxsdk.annotations.Polyline  
SystemStatus Intent/BroadcastReceiver constants. 
SystemStatus.DeviceStatus  
SystemStatus.OperationStatus  

T

TelemetryConfig Used for configuring what kind of telemetry data the SDK should gather and at what interval data should be gathered. 
TelemetryConfig.BackgroundPolicy Configuration when Telemetry should be active and when to suspend it. 
TelemetryConfig.BeaconLevel Levels of telemetry data that is collected. 
TelemetryConfig.Builder Implements standard Builder for TelemetryConfig. 
TelemetryConfig.LocationLevel Levels of location data that is collected. 
TelemetryService Steerpath Telemetry Service. 

U

UiSettings UI configuration settings which relate to the functionality provided by SteerpathMap
UnauthorizedApiAccessRuntimeException Thrown if API key JWS check fails. 

W

Waypoint Waypoint is a point or place on a route.