com.zendrive.sdk

Class Zendrive

java.lang.Object

com.zendrive.sdk.Zendrive

public abstract class Zendrive
extends java.lang.Object

Zendrive class is the entry point into the Zendrive SDK. This is the typical usage:

 
  public class MyActivity extends Activity {
      ...
      static final String ZENDRIVE_SDK_KEY_STRING = ...
      ...


      public void setupZendriveSDK(View v){
          ...
          ZendriveConfiguration zendriveConfiguration = new ZendriveConfiguration(
               ZENDRIVE_SDK_KEY_STRING, driverId);
          Zendrive.setup(this.getApplicationContext(),
              zendriveConfiguration, MyZendriveIntentService.class,
              new ZendriveOperationCallback() {
                  @Override
                  public void onCompletion(ZendriveOperationResult result) {
                      if (result.isSuccess()) {
                          Log.d(MY_APP_TAG, "Zendrive is setup.");
                      }
                  }
              }
          );
      }
      ...
  }
  
 

Other than setup, all methods are optional to call by the application. They are also no-ops in case setup has not been called. All methods are threadsafe.

Method Summary

Modifier and Type	Method and Description
static ActiveDriveInfo	getActiveDriveInfo() Get info on the currently active drive.
static java.lang.String	getBuildVersion() Returns an identifier which can be used to identify this SDK build.
static java.util.Map<ZendriveEventType,java.lang.Boolean>	getEventSupportForDevice(android.content.Context context) Check whether the zendrive event types are supported or not on this device
static ZendriveState	getZendriveState() Get the current state of the Zendrive SDK.
static boolean	isAccidentDetectionSupported(android.content.Context context) Is Zendrive collision detection supported on this device?
static boolean	isSDKSetup() Is the Zendrive SDK already setup?
static boolean	isValidInputParameter(java.lang.String input) Checks whether the string passed to the SDK is valid.
static void	setup(android.content.Context context, ZendriveConfiguration zendriveConfiguration, java.lang.Class<? extends ZendriveBroadcastReceiver> broadcastReceiverClass, java.lang.Class<? extends ZendriveNotificationProvider> notificationProviderClass, ZendriveOperationCallback callback) Setup the Zendrive SDK with a configuration and a intent service for SDK callbacks.
static void	setZendriveDriveDetectionMode(ZendriveDriveDetectionMode driveDetectionMode, ZendriveOperationCallback callback) Use this method to change the ZendriveDriveDetectionMode after SDK is already setup.
static void	startDrive(java.lang.String trackingId, ZendriveOperationCallback callback) Manually start recording a drive.
static ZendriveOperationResult	startSession(java.lang.String sessionId) Start a session in the SDK.
static void	stopDrive(java.lang.String trackingId, ZendriveOperationCallback callback) Stop the currently active manually started drive.
static ZendriveOperationResult	stopSession() Stop currently ongoing session.
static void	teardown(ZendriveOperationCallback callback) Shuts down the Zendrive framework.
static void	triggerMockAccident(android.content.Context context, ZendriveAccidentConfidence confidence, ZendriveOperationCallback callback) Triggers a fake accident.
static ZendriveOperationResult	uploadAllDebugDataAndLogs() Allows an application to trigger a bulk upload of all SDK data on the device to Zendrive for debugging purposes.
static void	wipeOut(android.content.Context context, ZendriveOperationCallback callback) Wipe out all the data that zendrive keeps locally on the device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setup

public static void setup(android.content.Context context,
                         ZendriveConfiguration zendriveConfiguration,
                         java.lang.Class<? extends ZendriveBroadcastReceiver> broadcastReceiverClass,
                         java.lang.Class<? extends ZendriveNotificationProvider> notificationProviderClass,
                         ZendriveOperationCallback callback)

Setup the Zendrive SDK with a configuration and a intent service for SDK callbacks. This will start tracking the phone's movements to track any driving activity. The application should call this method before anything else in the Zendrive SDK. Calling this method multiple times with the same 'sdkKey' and 'driverId' in the ZendriveConfiguration is a no-op. If provided, the ZendriveBroadcastReceiver class will be sent SDK callbacks after the call. If either the 'sdkKey' or 'driverId' in the ZendriveConfiguration changes between the previous setup call and this one, it will be the same as calling teardown(ZendriveOperationCallback) followed by calling setup with the new parameters. Once setup finishes, the ZendriveOperationCallback is called (if provided) with the result of the setup operation. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread. In addition to the callback, the SDK also issues a broadcast intent after setup. The application can listen to this broadcast to take any post setup actions. On setup success, the intent action is of the format - application_package_name.ZENDRIVE.SETUP_SUCCESS or application_package_name.ZENDRIVE.SETUP_FAILURE. For example - "com.zendrive.sample.ZENDRIVE_SETUP_SUCCESS" and "com.zendrive.sample.ZENDRIVE_SETUP_FAILURE" are the intent actions for an app running with the package "com.zendrive.sample".

Parameters:

context - is the context object of the enclosing application.

zendriveConfiguration - The configuration properties to setup the Zendrive SDK. Cannot be null.

broadcastReceiverClass - A intent service which receives callbacks from the SDK. It receives updates about interesting events like start and end of a drive, accident detected etc from the SDK. Specify null if you don't want to receive callbacks from the SDK.

notificationProviderClass - A ZendriveNotificationProvider class that is used to fetch notifications when the sdk goes foreground.

callback - The callback to be invoked after setup. It will be invoked on the same thread where setup is called. This can be 'null' if no callback is desired by the application.

teardown

public static void teardown(ZendriveOperationCallback callback)

Shuts down the Zendrive framework. This may be called if the client code wishes to turn off the Zendrive framework to isolate the operations that the application is doing. This is a no-op if setup(Context, ZendriveConfiguration, Class, Class, ZendriveOperationCallback) setup} has not been called. Once teardown finishes, the ZendriveOperationCallback is called (if provided) with the result of the teardown operation. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread. N.B. the library is typically very conservative about what modules of the phone it uses for tracking and how much memory it uses etc. and as such is very conservative about memory and battery impact. So this method should not really be called to save power / memory for the application.

setZendriveDriveDetectionMode

public static void setZendriveDriveDetectionMode(ZendriveDriveDetectionMode driveDetectionMode,
                                                 ZendriveOperationCallback callback)

Use this method to change the ZendriveDriveDetectionMode after SDK is already setup. Applications which do not want the SDK to continuously track drives in background should set this value to AUTO_OFF. With this, the application needs to call startDrive(java.lang.String, com.zendrive.sdk.ZendriveOperationCallback) method to record drives. In case the application wants to enable auto drive detection only for a fixed duration (like when the driver is on-duty), use this method to change the mode to AUTO_ON for that period and set it back to AUTO_OFF (once the driver goes off-duty). Once setup finishes, the ZendriveOperationCallback is called (if provided) with the result of the setup operation. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread.

Parameters:

driveDetectionMode - The new drive detection mode. If this is the same as the current ZendriveDriveDetectionMode, then this call is a no-op.

callback - called with the result of the operation when completed. In case of any error encountered, the result contains the relevant error details.

startDrive

public static void startDrive(java.lang.String trackingId,
                              ZendriveOperationCallback callback)

Manually start recording a drive. For applications which want to manually start recording drives(as opposed to automatic detection that the framework does) this method may be called. Any auto-detected drives in progress will be terminated and a new drive will be started at this time. The 'trackingId' will eventually show up in the reports that Zendrive generates. When this method is called it is the client code's responsibility to call stopDrive(java.lang.String, com.zendrive.sdk.ZendriveOperationCallback) to indicate the end of the drive. These methods should be used when the application has explicit knowledge of the start and end of a drive. In such applications, using this call is recommended). When startDrive is called with a manually recorded drive in progress, if trackingId matches the ongoing drive's trackingId, this call is a no-op. If the trackingIds do not match, stopDrive(java.lang.String, com.zendrive.sdk.ZendriveOperationCallback) is called implicitly before a new drive is started. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread.

Parameters:

trackingId - an identifier which allows identifying this drive uniquely. This identifier must be unique for this user. It may not be null or a empty string. It will be truncated to 64 characters if it is longer than 64 characters. Passing invalid trackingId is an error.

callback - called with the result of the operation

stopDrive

public static void stopDrive(java.lang.String trackingId,
                             ZendriveOperationCallback callback)

Stop the currently active manually started drive. The startDrive(java.lang.String, com.zendrive.sdk.ZendriveOperationCallback) and stopDrive calls are not counted. i.e stopDrive will stop a manually started drive irrespective of how many times startDrive(java.lang.String, com.zendrive.sdk.ZendriveOperationCallback) is called. This call has no effect on an automatically detected drive that may be in progress. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread.

Parameters:

trackingId - This identifier should match the trackingId sent to startDrive(java.lang.String, com.zendrive.sdk.ZendriveOperationCallback) method while starting the current drive. If the trackingIds do not match, this function is a no-op. Cannot be null or empty string.

callback - called with the result of the operation when completed

startSession

public static ZendriveOperationResult startSession(java.lang.String sessionId)

Start a session in the SDK. Applications which want to record several user's drives as a session may use this call. All drives (automatically detected or manually started) when a session is in progress will be tagged with the session id. If a drive is already on when this call is made, that drive will not belong to this session. This session id will be made available in the reports and API that Zendrive provides. The application must call stopSession() when it wants to end the session. Only one session may be active at a time. Calling startSession when a session is already active will terminate the ongoing session and start a new one with the given id.

Parameters:

sessionId - an identifier that identifies this session uniquely. It may not be null or an empty string. It may not be longer than 64 characters. Passing invalid sessionId is a no-op.

Returns:

the result of the startSession operation.

stopSession

public static ZendriveOperationResult stopSession()

Stop currently ongoing session. No-op if no session is ongoing. Trips that start after this call do not belong to the session. Ongoing trips at the time of this call will continue to belong to the session that was just stopped.

Returns:

the result of the stopSession operation.

See Also:

startSession(String)

isValidInputParameter

public static boolean isValidInputParameter(java.lang.String input)

Checks whether the string passed to the SDK is valid. String parameters cannot be null or empty. Unless documented otherwise, strings parameters to the SDK cannot contain any of the following characters - "?", " ", "&", "/", "\", ";", "#"

Parameters:

input - The string to validate

Returns:

true if the string is valid, false otherwise

isSDKSetup

public static boolean isSDKSetup()

Is the Zendrive SDK already setup?

Returns:

true if Zendrive SDK is already setup. Else false.

triggerMockAccident

public static void triggerMockAccident(android.content.Context context,
                                       ZendriveAccidentConfidence confidence,
                                       ZendriveOperationCallback callback)

Triggers a fake accident. A fake accident will be invoked on the ZendriveListener after this function is called. Requires that the Zendrive SDK is setup and a trip is in progress. This function can be used to test the accident detection integration of your application. Once setup finishes, the ZendriveOperationCallback is called (if provided) with the result of the setup operation. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread.

Parameters:

context - is the context object of the enclosing application

confidence - is the confidence level of the accident to trigger

callback - called with the result of the operation when completed. In case of any error encountered, the result contains the relevant error details.

getBuildVersion

public static java.lang.String getBuildVersion()

Returns an identifier which can be used to identify this SDK build.

isAccidentDetectionSupported

public static boolean isAccidentDetectionSupported(android.content.Context context)

Is Zendrive collision detection supported on this device?

Returns:

true if zendrive collision detection is supported on this device.

getEventSupportForDevice

public static java.util.Map<ZendriveEventType,java.lang.Boolean> getEventSupportForDevice(android.content.Context context)

Check whether the zendrive event types are supported or not on this device

Returns:

a map where for each zendrive event type, there is a boolean indicating if it is supported or not.

uploadAllDebugDataAndLogs

public static ZendriveOperationResult uploadAllDebugDataAndLogs()

Allows an application to trigger a bulk upload of all SDK data on the device to Zendrive for debugging purposes. This uploads historical data and logs on the device. WARNING: This will cause significant battery drain on the device. It will also use significant upload bandwidth to upload this data.. This is meant to be used sparingly by applications. This should be used only when you have raised a ticket with Zendrive and Zendrive support recommends this approach to debug the issue.

wipeOut

public static void wipeOut(android.content.Context context,
                           ZendriveOperationCallback callback)

Wipe out all the data that zendrive keeps locally on the device. When Zendrive SDK is torn down, trip data that is locally persisted continues to remain persisted. The data will be uploaded when SDK setup is called at a later time. Wipeout should be used when the application wants to remove all traces of Zendrive on the device. Data cannot be recovered after this call. NOTE: This call can be made when the SDK is not running. Call teardown(ZendriveOperationCallback) to tear down a live SDK before making this call. Callback will be made on calling thread if it's Looper is already prepared, else the callback is made on the Main Thread.

Parameters:

context - The context of the enclosing application.

callback - Called with the result of the operation.

getActiveDriveInfo

public static ActiveDriveInfo getActiveDriveInfo()

Get info on the currently active drive. If sdk is not setup or if no drive is in progress, null is returned.

Returns:

Info about the currently active drive or null.

getZendriveState

public static ZendriveState getZendriveState()

Get the current state of the Zendrive SDK. If sdk is not setup, this returns null.

Returns:

the current state of the Zendrive SDK