STREAMWIDE SDK Android 3.12.1/com.streamwide.smartms.lib.core.api.loneworker/STWLoneWorkerManager

STWLoneWorkerManager

Class responsible to manage all lone worker services ( Man down, Positive security)

This class offers several possible operations defined in the following list:

Start lone worker service
Stop lone worker service
Schedule lone worker service
reCalibration
Stop man down alert
Acknowledge an man down alert
Check services states

Start and check lone worker services


.......
STWLoneWorkerManager.getInstance().startLoneWorker(context, needToRestartService, loneWorkerStartCallback);
........

Stop lone worker service


......
STWLoneWorkerManager.getInstance().stopLoneWorker(context);
......

Schedule lone worker service


......
STWLoneWorkerManager.getInstance().scheduleLoneWorker(context, loneWorkerDelay, informServer);
......

reCalibration


......
STWLoneWorkerManager.getInstance().recalibrate(context, loneWorkerStartCallback);
......

Stop man down alert


.....
STWLoneWorkerManager.getInstance().stopManDownAlert(context);
........


.....
STWLoneWorkerManager.getInstance().stopManDownAlert(Context context , String threadId);
........

Acknowledge an man down alert


.....
STWLoneWorkerManager.getInstance().setManDownAlertAcknowledged(this, messageId);
........

Types

LoneWorkerCallback

interface LoneWorkerCallback

ManDownCallback

interface ManDownCallback

PositiveSecurityCallback

interface PositiveSecurityCallback

SnoozeCallback

interface SnoozeCallback

Functions

cancelManDownAlert

open fun cancelManDownAlert(@NonNull context: Context, angle: Int)

Use this method to cancel the current man down alert operation

getCurrentManDownState

@NonNull

open fun getCurrentManDownState(): String

Use this method to retrieve the current ManDown state

getInstance

@NonNull

open fun getInstance(): STWLoneWorkerManager

getLastConnectionLostTime

@Nullable

open fun getLastConnectionLostTime(): Date

Use this method to retrieve the positive security connection lost time

getLastManDownThreadId

@Nullable

open fun getLastManDownThreadId(): String

Use this method retrieve the last threadID for the emergency man down alert

getPreAlarmProgressState

@NonNull

open fun getPreAlarmProgressState(): Pair<Long, Long>

Use this method to retrieve the current preAlarm progress value and the preAlarm configured delay

initLoneWorkerUserSettings

open fun initLoneWorkerUserSettings(@NonNull loneWorkerUserSettingsConfig: LoneWorkerUserSettingsConfig)

Use this method to initialise the LoneWorker settings config

isConnectionLostDetected

open fun isConnectionLostDetected(): Boolean

Use this method to check if the connection lost is detected or not

isConversationForManDown

open fun isConversationForManDown(@NonNull context: Context, @NonNull threadId: String): Boolean

Check if the conversation is for Man Down

isDeviceCalibrated

open fun isDeviceCalibrated(): Boolean

If the caliration is already Done

isLoneWorkerAllowed

open fun isLoneWorkerAllowed(): Boolean

If the subscriber is allowed to use lone worker feature

isManDown

open fun isManDown(): Boolean

isManDownCall

open fun isManDownCall(@NonNull callerPhoneItem: PhoneItem): Boolean

Use this method to check if the caller phone is in the man down recipient call or not

isManDownDetectionAllowed

open fun isManDownDetectionAllowed(): Boolean

If the subscriber is allowed to use man down feature

isManDownEnabled

open fun isManDownEnabled(@NonNull context: Context): Boolean

If the subscriber is allowed to use man down feature and ManDown detection recipient is not empty

isPositiveSecurityAllowed

open fun isPositiveSecurityAllowed(): Boolean

If the subscriber is allowed to use positive security feature

positiveSecurityAcknowledged

open fun positiveSecurityAcknowledged()

Use this method when positive security alarm is acknowledged

recalibrate

open fun recalibrate(@NonNull context: Context, @Nullable callback: LoneWorkerStartCallback)

Use this method to restart the calibration phase again

registerPreAlarmTimerObserver

open fun registerPreAlarmTimerObserver(@NonNull smartMSTimerObserver: SmartMSTimerObserver)

Use this method to listen for the ManDown PreAlarm timer

registerToLoneWorkerEvent

open fun registerToLoneWorkerEvent(@NonNull loneWorkerCallback: STWLoneWorkerManager.LoneWorkerCallback)

registerToManDownEvent

open fun registerToManDownEvent(@NonNull manDownCallback: STWLoneWorkerManager.ManDownCallback)

registerToPositiveSecurityEvent

open fun registerToPositiveSecurityEvent(@NonNull positiveSecurityCallback: STWLoneWorkerManager.PositiveSecurityCallback)

scheduleLoneWorker

open fun scheduleLoneWorker(@NonNull context: Context, loneWorkerDelay: Int)

open fun scheduleLoneWorker( @NonNull context: Context, loneWorkerDelay: Int, informServer: Boolean)

Use this method to schedule the start of the lone worker manager

setManDownAlertAcknowledged

open fun setManDownAlertAcknowledged(@NonNull context: Context, @NonNull message: BaseMessage)

startLoneWorker

open fun startLoneWorker( @NonNull context: Context, needToRestartService: Boolean, @Nullable callback: LoneWorkerStartCallback)

Use this method to start the lone worker service

open fun startLoneWorker( @NonNull context: Context, needToRestartService: Boolean, startCalibration: Boolean, phoneIsLocked: Boolean, @Nullable callback: LoneWorkerStartCallback)

Use this method to start the lone worker manager

stopLoneWorker

open fun stopLoneWorker(@NonNull context: Context)

Use this method to stop the lone worker manager

stopManDownAlert

open fun stopManDownAlert(@NonNull context: Context)

Use this method to stop the man down alert

open fun stopManDownAlert(@NonNull context: Context, @NonNull threadId: String)

Stop the man down alert corresponding the the specified thread

unregisterLoneWorkerEvent

open fun unregisterLoneWorkerEvent(@NonNull loneWorkerCallback: STWLoneWorkerManager.LoneWorkerCallback)

Unregister the specified listener to not receive any more the Lone worker changes

unregisterManDownEvent

open fun unregisterManDownEvent(@NonNull manDownCallback: STWLoneWorkerManager.ManDownCallback)

Unregister the specified listener to not receive any more the Man down changes

unregisterPositiveSecurityEvent

open fun unregisterPositiveSecurityEvent(@NonNull positiveSecurityCallback: STWLoneWorkerManager.PositiveSecurityCallback)

Unregister the specified listener to not receive any more the Positive security changes

unregisterPreAlarmTimerObserver

open fun unregisterPreAlarmTimerObserver(@NonNull smartMSTimerObserver: SmartMSTimerObserver)

Use this method to remove the previously listener instance callback