Class Index - Steerpath SDK

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

B

BottomSheetBehavior<V extends View> https://code.videolan.org/videolan/vlc-android/commit/766d8e8c39341b2a3f831e8e32ce7ea67960eea2 Created by opiirone on 02/04/2018. 

C

CompassCalibrationFragment DialogFragment that contains instructions for compass calibration. 
CompassUtils CompassUtils notifies if compass calibration is required. 
CompassUtils.Listener Invoked when sensor accuracy stawtus  
Constants Steerpath Constants are used by multiple modules. 

D

DefaultDirectionSheet SDK's default DirectionSheet implementation. 
DefaultDirectionSheet.EventListener Callback to notify about actions user took. 
DefaultNextWaypointRouteOptionsFactory SDK's default route line appearance for "next route segment". 
DefaultRouteOptionsFactory SDK's default route line appearance. 
DefaultRoutePreviewHolder SDK's default RoutePreview-badge implementation. 
DefaultRoutePreviewOptionsFactory SDK's default route line appearance when in preview-mode. 
DefaultRouteStepViewHolder SDK's default View for displaying navigation progress in BottomSheet. 
DefaultWaypointViewHolder SDK's default View for displaying Waypoint information in BottomSheet. 
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. 
DirectionsApiAccessor Accessor is part of the API, but cannot be instantiated or listened to outside of the friend classes that are in the AOI package and the other packages. 
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. 
DirectionsException Exception class used by the DirectionsListener to indicate one or more of the routes failed to be solved. 
DirectionSheet Interface definition for a callback to be invoked when full directions list is shown. 
DirectionSheet.Data Wrapper class that groups arguments together. 
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 EidUpdater fetches necessary EID packages. 
EidUpdater.UpdateListener UpdateListener is called in response to EidUpdater.update()  
Error Describes what went wrong with your query. 

F

FakeLocationSource LocationSource that publishes "fake location updates" once per second. 
Foreground Usage: 1. 
Foreground.Listener  
FusedLocationProviderApi The FusedLocationProviderApi provides a way to request location updates. 
FusedLocationProviderApi.Api Separates API from implementation. 
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. 
GeofencingApiAccessor Created by opiirone on 02/01/2018. 
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. 

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

LocalizationHelper LocalizationHelper is meant to be used with RouteStepViewHolder and DirectionSheet
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. 
LocationRequest A location request defines parameters for how accurate and how frequent location updates should be. 
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. 
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. 
MoveUpwardBehavior Created by opiirone on 19/12/2017. 

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 Interace 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 of 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. 
RoutePreviewHolder Interface definition for a callback to be invoked when route preview bar is shown. 
RouteStep A route is made up out of steps describing what actions a user needs to take to follow the route. 
RouteStep.Action  
RouteStepViewHolder With this interface, "current RouteStep" badge gets notifications when to create and update itself. 
RouteTracker The RouteTracker is used for monitoring progress along a given Route
RouteTrackerProgress Instances of this class describe the progress on the tracked route. 
RouteUtils Route helpers. 

S

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. 
SteerpathMapOptions.Builder Implements standard Builder for SteerpathMapOptions. 
SteerpathMapView The SteerpathMapView extends the MapView provided by Mapbox in order to implement features that relate to indoor positoning. 
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  
StopNavigationButtonBehavior Simple CoordinatorLayout.Behavior that checks visibility of dependency View and sets associated FAB visible or invisible. 
SystemStatus Intent/BroadcastReceiver constants. 

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  
TelemetryUploadJobService JobService that send collected Telemetry data to the backend. 

U

UiSettings UI configuration settings which relate to the functionality provided by SteerpathMap

W

Waypoint Waypoint is a point or place on a route. 
WaypointViewHolder Interface definition for a callback for creating a Waypoint Badge (SteerpathMapView's BottomSheet).