-
- All Implemented Interfaces:
-
com.pointrlabs.core.management.interfaces.Advertiser
public class Pointr extends PTRAdvertiserImpl<PointrListener>
Entry class for Pointr SDK. For Pointr SDK to work properly, please take the following steps Initialize the Pointr instance with with at the earliest possible time. Advised place to perform this is onCreate method
To start to use the SDK manager, you have to start the sdk and make sure it's running. To start the SDK @see start To listen the Pointr SDK progress updates
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
Pointr.State
The enum Pointr state.
-
Field Summary
Fields Modifier and Type Field Description private Pointr.State
state
private final PermissionManager
permissionManager
private final KeyValueStore
keyValueStore
final ConfigurationManager
configurationManager
private final LocationSharingManager
locationSharingManager
private final PoiManager
poiManager
private final GeofenceManager
geofenceManager
private final UserManager
userManager
private final DataManager
dataManager
private final PathManager
pathManager
private final PositionManager
positionManager
private final SiteManager
siteManager
private final ObstacleManager
obstacleManager
private final GraphManager
graphManager
private final ARController
arController
private final PointrDebug
pointrDebug
-
Method Summary
Modifier and Type Method Description Pointr.State
getState()
void
setState(Pointr.State newState)
PermissionManager
getPermissionManager()
KeyValueStore
getKeyValueStore()
ConfigurationManager
getConfigurationManager()
LocationSharingManager
getLocationSharingManager()
Gets location sharing manager. PoiManager
getPoiManager()
Gets poi manager. GeofenceManager
getGeofenceManager()
Gets geofence manager. UserManager
getUserManager()
Gets user manager. DataManager
getDataManager()
Gets data manager. PathManager
getPathManager()
Gets path manager. synchronized PositionManager
getPositionManager()
Gets position manager. synchronized SiteManager
getSiteManager()
Gets Site Site Manager. ObstacleManager
getObstacleManager()
Get ObstacleManager GraphManager
getGraphManager()
Get GraphManager synchronized ARController
getArController()
Get AR Controller. synchronized PointrDebug
getPointrDebug()
Gets PointrDebug. static Pointr
getPointr()
Gets pointr instance. static void
with(@NonNull() Context context, PTRParams ptrParams)
Initialize the Pointr SDK void
startRecorder()
This is a method that starts the Pointr Recorder for debugging the beacon environment void
stopRecorder()
This is a method that stops the Pointr Recorder after it was started for debuggin the beacon environment. synchronized void
start()
Starts the Pointr SDK synchronized void
startAsForegroundService(@NonNull() PointrServiceParams pointrServiceParams, boolean shouldKeepCpuOn)
Starts pointr as foreground service. synchronized void
stopForegroundService()
Stops the foreground service. synchronized void
stop()
Stops the pointr managers boolean
waitUntil(@NonNull() Set<Integer> sites, @NonNull() Set<DataType> dataTypes, double timeoutInSeconds)
Blocks until all selected types for set sites are available. -
Methods inherited from class com.pointrlabs.core.util.PTRAdvertiserImpl
addListener, advertise, getListeners, getLock, isListenersEmpty, removeAllListeners, removeListener, setListeners
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getState
Pointr.State getState()
-
setState
void setState(Pointr.State newState)
-
getPermissionManager
@Nullable() PermissionManager getPermissionManager()
-
getKeyValueStore
@NonNull() KeyValueStore getKeyValueStore()
-
getConfigurationManager
@Nullable() ConfigurationManager getConfigurationManager()
-
getLocationSharingManager
@Nullable() LocationSharingManager getLocationSharingManager()
Gets location sharing manager.
-
getPoiManager
@Nullable() PoiManager getPoiManager()
Gets poi manager.
-
getGeofenceManager
@Nullable() GeofenceManager getGeofenceManager()
Gets geofence manager.
-
getUserManager
@Nullable() UserManager getUserManager()
Gets user manager.
-
getDataManager
@Nullable() DataManager getDataManager()
Gets data manager.
-
getPathManager
@Nullable() PathManager getPathManager()
Gets path manager.
-
getPositionManager
@Nullable() synchronized PositionManager getPositionManager()
Gets position manager.
-
getSiteManager
@Nullable() synchronized SiteManager getSiteManager()
Gets Site Site Manager.
-
getObstacleManager
ObstacleManager getObstacleManager()
Get ObstacleManager
-
getGraphManager
GraphManager getGraphManager()
Get GraphManager
-
getArController
@Nullable() synchronized ARController getArController()
Get AR Controller.
-
getPointrDebug
@Nullable() synchronized PointrDebug getPointrDebug()
Gets PointrDebug.
-
with
static void with(@NonNull() Context context, PTRParams ptrParams)
Initialize the Pointr SDK
- Parameters:
context
- the application contextptrParams
- parameters required for initializing Pointr PTRParams
-
startRecorder
void startRecorder()
This is a method that starts the Pointr Recorder for debugging the beacon environment
-
stopRecorder
void stopRecorder()
This is a method that stops the Pointr Recorder after it was started for debuggin the beacon environment.
-
start
synchronized void start()
Starts the Pointr SDK
-
startAsForegroundService
synchronized void startAsForegroundService(@NonNull() PointrServiceParams pointrServiceParams, boolean shouldKeepCpuOn)
Starts pointr as foreground service. You can provide the parameters to be used while displaying the notification
- Parameters:
pointrServiceParams
- to define the content for the notification displayed in foreground serviceshouldKeepCpuOn
- to decide whether to acquire a wake lock to keep CPU on
-
stopForegroundService
synchronized void stopForegroundService()
Stops the foreground service.
-
stop
synchronized void stop()
Stops the pointr managers
-
-
-
-