Class Index - Steerpath SDK

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

A

AntiPattern If design patterns are the good guys, then the anti-patterns are the bad guys. 
AssetGateway Asset Gateway is used for tracking assets (Steerpath Asset Beacons) real time. 

B

BackgroundModeService BackgroundModeService keeps indoor positioning alive when app is sent to the background. 
BackgroundModeService.NotificationActionReceiver Listens Actions requests received from the Notifications. 
BlueDotListener The listener interface for receiving user's approximate location updates. 
BluetoothScanner Wrapper interface for Android's pre-Lollipop and Lollipop BluetoothScanner. 
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 View 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. 
BottomSheetStateListener Interface definition for receiving BottomSheet state change updates. 

C

CodeSmell Sniff sniff, what's that smell? Annotate your stinky code for future refactoring!

Code smells are similar to anti-patterns, but not quite as formal. 
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. 

F

FakeLocationProvider LocationProvider that publishes "fake location updates" once per second. 
FifoBuffer<T> FifoBuffer pushes firstly added item when size limit is exceeded. 
FileCache FileCache is a mediator between local File and Steerpath Server. 
FileReader FileReader provides synchronous and asynchronous methods to read File content. 
FileReader.Callback<T>  
FileServices Access point to storage, databases and Files. 
FileUpdater This is mainly for SDK internals and has little use outside of the SDK. 
FileWriter FileWriter provides synchronous and asynchronous methods to manipulate File contents. 
FileWriter.Callback<T>  
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. 
FusedLocationProvider The FusedLocationProvider 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. 
GeoJsonPointLocationProvider Publishes Locations from given FeatureCollection. 
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. 
InfoBottomSheetOptions Parameters for InfoBottomSheet. 
InfoBottomSheetOptions.CloseButtonCallback Interface definition for listening "close"-button click events. 
InfoBottomSheetOptions.StartNavigationButtonCallback Interface definition for listening "start navigation"-button click events. 
Item Item is an interface that allows data types such as MetaFeature or LiveUser to be treated identically. 
ItemFactory Creates an Item 
ItemFactory.Builder Standard Builder. 
ItemType  

L

LeScanCallback Wrapper interface for Android's pre-Lollipop and Lollipop Bluetooth ScanCallbacks. 
Live Steerpath Live manages the information about other users and bookable spaces, such as meeting rooms, desks and frameries. 
LiveAsset LiveAsset can be for example room, desk, framery or other bookable or reservable space in a building. 
LiveAsset.Occupancy  
LiveAssetCallback Callback definition for receiving LiveAsset information from the server. 
LiveMapOptions Use this class to configure SteerpathMapView to show LiveUsers on the map. 
LiveOptions Use this class to configure live settings for this user/device. 
LiveServices Access point to Steerpath Live. 
LiveUpdateListener Listener definition to periodically receive raw data (geojson) packets from the server. 
LiveUser Data model for Live User. 
LiveUserCallback Callback definition for receiving LiveUser information from the server. 
LiveUserListener The listener interface for receiving LiveUser status updates. 
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 Abstraction to provide user Location a.ka the BlueDot. 
LocationRequest A location request defines parameters for how accurate and how frequent location updates should be. 
LocationServices Access point to Location API. 
LoginCallback Callback definition for receiving information about login to Steerpath Live. 

M

MalformedOfflineBundleException Thrown if OfflineBundle installation fails due to internal error in OfflineBundle data. 
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  
Marker Concrete Marker is immutable model class tha represents a marker on the map. 
MarkerListener The listener interface for receiving Marker events. 
MarkerOptions MarkerOptions is a specification how to create a Marker-object. 
MarkerOptions.Builder In this case, classic Builder works better that Fluent API. 
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. 
MetaItemFactory Converts MetaFeature into {@Item } 
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 Represents bundled offline data. 
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. 
OnSearchSuggestionSelectedCallback Interface definition for receiving events when user selects SearchSuggestion from the SearchBottomSheet. 

P

PermissionActivity PermissionActivity requests missing Runtime Permissions and broadcasts BROADCAST_PERMISSIONS_RESULT when ready. 
PermissionChecker Checks Runtime Permissions and launches PermissionActivity if needed. 
Preferences Preferences for the SDK user. 
PreferenceServices Different users with different SdkConfig may require different preferences. 

Q

QueryCallback<T> Interface definition for receiving query results. 
QueryError File Query error codes. 
QueryException Thrown if query(Specification) fails. 

R

Repository<T> Abstract Repository definition. 
ResourceMapper Resolves Android Resource (@DrawableRes or @StringRes) from the resource name (String). 
Route A route defines the directions from a source to a destination. 
RouteListener RouteListener is callback that is invoked in response to SteerpathMapView#navigateTo(RoutePlan, RouteListener) and SteerpathMapView#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  
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

SdkConfig Immutable configuration object that contains URLs and other parameters for the SDK. 
SdkConfig.BottomSheetState  
SdkConfig.Builder Standard Builder for the SdkConfig. 
SdkConfig.PermissionCheckTrigger  
SdkConfig.ServiceRegion  
SdkConfig.TelemetryBackgroundPolicy  
SdkConfig.TelemetryBeaconLevel  
SdkConfig.TelemetryLocationLevel  
SdkInfo Basic SDK information. 
SdkLoadException Thrown if start(Context, SdkConfig, SdkStartCallback) fails. 
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. 
SdkStartCallback The callback interface for receiving information of SteerpathClient loading process. 
SearchBottomSheetOptions Parameters for SearchBottomSheet. 
SearchIndexUpdater Interface definition for updating searchable item index. 
Specification Abstraction for Repository query. 
SteerpathAnnotation Deprecated: Will be removed when proper replacement has been implemented for managing Layers. 
SteerpathAnnotationOptions AnnotationOptions is extension to BaseMarkerViewOptions, BaseMarkerOptions, PolylineOptions and PolygonOptions. 
SteerpathAnnotationOptions.Builder Implements standard Builder for SteerpathAnnotationOptions. 
SteerpathClient Main entry point to the SDK. 
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 positioning. 
SteerpathMapView.LocateMeButtonListener Application may interrupt LocateMe-button clicks with this callback. 
SteerpathMapView.LocateMeButtonMode  
SystemStatus Intent/BroadcastReceiver constants. 
SystemStatus.DeviceStatus  
SystemStatus.OperationStatus  
SystemStatus.SdkStatus  

T

TelemetryConfig Used for configuring what kind of telemetry data the SDK should gather and at what interval data should be gathered. 
TelemetryConfig.BackgroundPolicy  
TelemetryConfig.BeaconLevel  
TelemetryConfig.Builder Implements standard Builder for TelemetryConfig. 
TelemetryConfig.LocationLevel  
TelemetryService Steerpath Telemetry Service. 

U

UnauthorizedApiAccessRuntimeException Thrown if API key JWS check fails. 

W

Waypoint Waypoint is a point or place on a route.