Android Point SDK  1.13.2
au.com.bluedot.point.net.engine.ServiceManager Class Reference

Service manager is used to interact with Bluedot Point Service. More...

Public Member Functions

void sendAuthenticationRequest (String apiKey, ServiceStatusListener listener)
 
void sendAuthenticationRequest (String apiKey, ServiceStatusListener listener, String url)
 
void sendAuthenticationRequest (String apiKey, ServiceStatusListener listener, boolean restartMode)
 
void sendAuthenticationRequest (String apiKey, ServiceStatusListener listener, boolean restartMode, String url)
 
void addBlueDotPointServiceStatusListener (ServiceStatusListener listener)
 
void removeBlueDotPointServiceStatusListener (ServiceStatusListener listener)
 
void setNotificationIDResourceID (int resourceID)
 
void subscribeForApplicationNotification (ApplicationNotificationListener applicationNotificationListener)
 
void unsubscribeForApplicationNotification (final ApplicationNotificationListener applicationNotificationListener)
 
ArrayList< ZoneInfogetZonesAndFences ()
 
void setCustomMessageAction (Class activity)
 
void stopPointService ()
 
boolean isBlueDotPointServiceRunning ()
 
boolean isBlueDotPointServiceConfiguredToRestart ()
 
void setZoneDisableByApplication (String zoneId, boolean disable)
 
boolean isZoneDisabledByApplication (String zoneId)
 
String getInstallRef ()
 
void notifyPushUpdate (Map< String, String > data)
 
String getSdkVersion ()
 
void setForegroundServiceNotification (int smallIconId, String title, String text, PendingIntent pendingIntent, boolean targetAllAPIs)
 
void setForegroundServiceNotification (Notification notification, boolean targetAllAPIs)
 
void setCustomEventMetaData (Map< String, String > customEventMetaData)
 

Static Public Member Functions

static ServiceManager getInstance (Context context)
 

Detailed Description

Service manager is used to interact with Bluedot Point Service.

Author
BluedotInnovation

Member Function Documentation

◆ addBlueDotPointServiceStatusListener()

void au.com.bluedot.point.net.engine.ServiceManager.addBlueDotPointServiceStatusListener ( ServiceStatusListener  listener)

Add a Bluedot PointService Status listener to monitor the status

Parameters
listener- instance of listener object supporting ServiceStatusListener interface

◆ getInstallRef()

String au.com.bluedot.point.net.engine.ServiceManager.getInstallRef ( )

Returns the installation reference of this Point SDK enabled App. This is the same as the Install Ref that appears in a Zone's Activity Log in Point Access, or queried via Open API. This reference is randomly generated at the first run-time of the App and remains fixed for the duration of the App installation.

Returns
the install reference

◆ getInstance()

static ServiceManager au.com.bluedot.point.net.engine.ServiceManager.getInstance ( Context  context)
static

Get Singleton instance of the ServiceManager. The app MUST get an instance of the ServiceManager in order to use the Bluedot Point Service.

Parameters
contextThe application or activity context
Returns
ServiceManager

◆ getSdkVersion()

String au.com.bluedot.point.net.engine.ServiceManager.getSdkVersion ( )

Returns the current version of the Point SDK

Returns
the current SDK version

◆ getZonesAndFences()

ArrayList<ZoneInfo> au.com.bluedot.point.net.engine.ServiceManager.getZonesAndFences ( )

Get Zones and Fences list.

Returns
- array list of ZoneInfo objects

◆ isBlueDotPointServiceConfiguredToRestart()

boolean au.com.bluedot.point.net.engine.ServiceManager.isBlueDotPointServiceConfiguredToRestart ( )

The client checks if the BluedotPointService is configured to run in Restarting mode.

Returns
True if the BluedotPointService is configured to run in Restarting mode.

◆ isBlueDotPointServiceRunning()

boolean au.com.bluedot.point.net.engine.ServiceManager.isBlueDotPointServiceRunning ( )

The client checks if the BluedotPointService is running.

Returns
True if the BluedotPointService is running otherwise false

◆ isZoneDisabledByApplication()

boolean au.com.bluedot.point.net.engine.ServiceManager.isZoneDisabledByApplication ( String  zoneId)

Giving the zone ID to check if the zone has been disabled by your application. The zone is enabled by default.

Parameters
zoneIdThe zone ID to check.
Returns
True if the zone is disabled otherwise false.

◆ notifyPushUpdate()

void au.com.bluedot.point.net.engine.ServiceManager.notifyPushUpdate ( Map< String, String >  data)

Notifies Point SDK that the push notification has been received with given data.

Parameters
data- map collection received through RemoteMessage

◆ removeBlueDotPointServiceStatusListener()

void au.com.bluedot.point.net.engine.ServiceManager.removeBlueDotPointServiceStatusListener ( ServiceStatusListener  listener)

Remove the Bluedot Point Service status listener if your app does not want to monitor the Bluedot Point service status anymore.

Parameters
listenerThe ServiceStatusListener to be removed.

◆ sendAuthenticationRequest() [1/4]

void au.com.bluedot.point.net.engine.ServiceManager.sendAuthenticationRequest ( String  apiKey,
ServiceStatusListener  listener 
)

Start the Bluedot Point Service by providing with the credentials and a ServiceStatusListener, the app will be notified via the status listener if the Bluedot Point Service started successful.

Parameters
apiKeyThe API key generated for your app in the Bluedot Point Access
listenerA Service Status Listener

◆ sendAuthenticationRequest() [2/4]

void au.com.bluedot.point.net.engine.ServiceManager.sendAuthenticationRequest ( String  apiKey,
ServiceStatusListener  listener,
String  url 
)

Start the Bluedot Point Service by providing with the credentials, a ServiceStatusListener and the Bluedot Point API end point url, the app will be notified via the status listener if the Bluedot Point Service started successful.

Parameters
apiKeyThe API key generated for your app in the Bluedot Point Access
listenerA Service Status Listener
urlThe end point url

◆ sendAuthenticationRequest() [3/4]

void au.com.bluedot.point.net.engine.ServiceManager.sendAuthenticationRequest ( String  apiKey,
ServiceStatusListener  listener,
boolean  restartMode 
)

Start the Bluedot Point Service by providing with the credentials, a ServiceStatusListener and the Bluedot Point API end point url, the app will be notified via the status listener if the Bluedot Point Service started successful.

Parameters
apiKeyThe API key generated for your app in the Bluedot Point Access
listenerA Service Status Listener
restartModeService will be restarted if the app is killed by the Android OS

◆ sendAuthenticationRequest() [4/4]

void au.com.bluedot.point.net.engine.ServiceManager.sendAuthenticationRequest ( String  apiKey,
ServiceStatusListener  listener,
boolean  restartMode,
String  url 
)

Start the Bluedot Point Service by providing with the credentials, a ServiceStatusListener and the Bluedot Point API end point url, the app will be notified via the status listener if the Bluedot Point Service started successful.

Parameters
apiKeyThe API key generated for your app in the Bluedot Point Access
listenerA Service Status Listener
restartModeService will be restarted if the app is killed by the Android OS
urlThe end point url

◆ setCustomEventMetaData()

void au.com.bluedot.point.net.engine.ServiceManager.setCustomEventMetaData ( Map< String, String >  customEventMetaData)

Sets custom MetaData for Notification Events

Parameters
customEventMetaData- the MetaData to be sent along with Notification

◆ setCustomMessageAction()

void au.com.bluedot.point.net.engine.ServiceManager.setCustomMessageAction ( Class  activity)

Set custom notification message action. This method specifies which activity will be displayed when the app has the message action. No activity will show up

Parameters
activity- Activity to start when the notification is clicked .

◆ setForegroundServiceNotification() [1/2]

void au.com.bluedot.point.net.engine.ServiceManager.setForegroundServiceNotification ( int  smallIconId,
String  title,
String  text,
PendingIntent  pendingIntent,
boolean  targetAllAPIs 
)

◆ setForegroundServiceNotification() [2/2]

void au.com.bluedot.point.net.engine.ServiceManager.setForegroundServiceNotification ( Notification  notification,
boolean  targetAllAPIs 
)

Sets parameters for foreground service notification. Only required for apps targeting Android O and above.

Parameters
notification- the Notification to be displayed; built by client's app
targetAllAPIs- Display notification on Android API version < 26

◆ setNotificationIDResourceID()

void au.com.bluedot.point.net.engine.ServiceManager.setNotificationIDResourceID ( int  resourceID)

Set the Resource ID for the Notification icon

Parameters
resourceID- Resource id from application drawable

◆ setZoneDisableByApplication()

void au.com.bluedot.point.net.engine.ServiceManager.setZoneDisableByApplication ( String  zoneId,
boolean  disable 
)

Enable the zone by providing with the zone ID.

Parameters
zoneIdThe zone's ID to be enabled or disabled
disableset True to disable the zone, false to enable the zone

◆ stopPointService()

void au.com.bluedot.point.net.engine.ServiceManager.stopPointService ( )

Stop the Bluedot Point Service.

◆ subscribeForApplicationNotification()

void au.com.bluedot.point.net.engine.ServiceManager.subscribeForApplicationNotification ( ApplicationNotificationListener  applicationNotificationListener)

Subscribe for Application Notifications

Parameters
applicationNotificationListener- instance of listener supporting ApplicationNotificationListener interface

◆ unsubscribeForApplicationNotification()

void au.com.bluedot.point.net.engine.ServiceManager.unsubscribeForApplicationNotification ( final ApplicationNotificationListener  applicationNotificationListener)

Unsubscribe for Application Notifications

Parameters
applicationNotificationListener- listener to be removed

The documentation for this class was generated from the following file: