com.zendrive.sdk

Class ZendriveConfiguration

java.lang.Object

com.zendrive.sdk.ZendriveConfiguration

public class ZendriveConfiguration
extends Object

The configuration to pass to Zendrive for Zendrive.setup(android.content.Context, com.zendrive.sdk.ZendriveConfiguration, java.lang.Class<? extends com.zendrive.sdk.ZendriveBroadcastReceiver>, java.lang.Class<? extends com.zendrive.sdk.ZendriveNotificationProvider>, com.zendrive.sdk.ZendriveOperationCallback). It contains properties like the sdk key, driver id, driver attributes etc.

Constructor Summary

Constructors

Constructor and Description
ZendriveConfiguration(JSONObject jsonObject) Creates a ZendriveConfiguration from its json representation.
ZendriveConfiguration(String sdkKey, String driverId) Creates a ZendriveConfiguration with the given sdk key and a driver id.
ZendriveConfiguration(String sdkKey, String driverId, ZendriveDriveDetectionMode driveDetectionMode) Creates a ZendriveConfiguration with the given sdk key, driver id and drive detection mode.
ZendriveConfiguration(String sdkKey, String driverId, ZendriveDriveDetectionMode driveDetectionMode, ZendriveRegion region) Creates a ZendriveConfiguration with the given sdk key, driver id, drive detection mode and region type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ZendriveDriverAttributes	getDriverAttributes() Returns the additional attributes of the current driver.
String	getDriverId() Returns the unique ID of the driver using this application.
boolean	getEnabledBluetoothDriveStart() Returns a boolean indicating if the app supports Bluetooth Drive Start.
boolean	getImplementsMultipleAccidentCallbacks() Returns a boolean indicating if the app supports receiving multiple callbacks.
ZendriveRegion	getRegion() Returns the region associated with the current driver.
String	getSdkKey() Returns the Zendrive sdk key used by this application.
ZendriveDriveDetectionMode	getZendriveDriveDetectionMode() Returns the drive detection mode specified for the Zendrive SDK.
int	hashCode()
void	setDriveDetectionMode(ZendriveDriveDetectionMode mode) Set the drive detection mode of this configuration.
void	setDriverAttributes(ZendriveDriverAttributes driverAttributes) Set the additional attributes of the current driver.
void	setEnabledBluetoothDriveStart(boolean enabledBluetoothDriveStart) Set this property to true if the app supports Bluetooth Drive Start.
void	setImplementsMultipleAccidentCallbacks(boolean implementsMultipleAccidentCallbacks) Set this property to true if the app supports receiving multiple callbacks.
void	setRegion(ZendriveRegion region) Set the region type of this configuration.
JSONObject	toJson() Return the json representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZendriveConfiguration

public ZendriveConfiguration(String sdkKey,
                             String driverId)

Creates a ZendriveConfiguration with the given sdk key and a driver id. Auto drive detection is on when Zendrive is Zendrive.setup(android.content.Context, com.zendrive.sdk.ZendriveConfiguration, java.lang.Class<? extends com.zendrive.sdk.ZendriveBroadcastReceiver>, java.lang.Class<? extends com.zendrive.sdk.ZendriveNotificationProvider>, com.zendrive.sdk.ZendriveOperationCallback) with this configuration.

Parameters:

sdkKey - The Zendrive sdk key for this application. The sdk key is available from the Zendrive developer portal. This cannot be null.

driverId - The Id of the driver currently using this application. Each driver using the application needs a unique Id. This same Id will be used in Zendrive driver analytics services like the dashboard and API. The driver Id may be upto 64 characters long. Additionally, the driver Id needs to be websafe. You can use Zendrive.isValidInputParameter(java.lang.String) to validate the driver Id. Passing an invalid id will cause the Zendrive SDK setup to fail. This cannot be null.

Throws:

NullPointerException - if sdkKey or driverId is null.

ZendriveConfiguration

public ZendriveConfiguration(String sdkKey,
                             String driverId,
                             ZendriveDriveDetectionMode driveDetectionMode)

Creates a ZendriveConfiguration with the given sdk key, driver id and drive detection mode.

Parameters:

sdkKey - The Zendrive sdk key for this application. The sdk key is available from the Zendrive developer portal . This cannot be null.

driverId - The Id of the driver currently using this application. Each driver using the application needs a unique Id. This same Id will be used in Zendrive driver analytics services like the dashboard and API. The driver Id may be upto 64 characters long. Additionally, the driver Id needs to be websafe. You can use Zendrive.isValidInputParameter(java.lang.String) to validate the driver Id. Passing an invalid id will cause the Zendrive SDK setup to fail. This cannot be null.

driveDetectionMode - The drive detection mode of the Zendrive SDK. Cannot be null.

Throws:

NullPointerException - if sdkKey or driverId or driveDetectionMode is null.

ZendriveConfiguration

public ZendriveConfiguration(String sdkKey,
                             String driverId,
                             ZendriveDriveDetectionMode driveDetectionMode,
                             ZendriveRegion region)

Creates a ZendriveConfiguration with the given sdk key, driver id, drive detection mode and region type.

Parameters:

sdkKey - The Zendrive sdk key for this application. The sdk key is available from the Zendrive developer portal . This cannot be null.

driverId - The Id of the driver currently using this application. Each driver using the application needs a unique Id. This same Id will be used in Zendrive driver analytics services like the dashboard and API. The driver Id may be upto 64 characters long. Additionally, the driver Id needs to be websafe. You can use Zendrive.isValidInputParameter(java.lang.String) to validate the driver Id. Passing an invalid id will cause the Zendrive SDK setup to fail. This cannot be null.

driveDetectionMode - The drive detection mode of the Zendrive SDK. Cannot be null.

region - Region for a driver, whose default state of region would be US until specified.

Throws:

NullPointerException - if sdkKey or driverId or driveDetectionMode or region is null.

ZendriveConfiguration

public ZendriveConfiguration(JSONObject jsonObject)
                      throws JSONException

Creates a ZendriveConfiguration from its json representation.

Parameters:

jsonObject - The json representation of a ZendriveConfiguration.

Throws:

JSONException - if the json could not be parsed properly.

Method Detail

getSdkKey

public String getSdkKey()

Returns the Zendrive sdk key used by this application.

Returns:

Returns the Zendrive sdk key used by this application.

getDriverId

public String getDriverId()

Returns the unique ID of the driver using this application.

Returns:

The unique ID of the driver using this application.

getZendriveDriveDetectionMode

public ZendriveDriveDetectionMode getZendriveDriveDetectionMode()

Returns the drive detection mode specified for the Zendrive SDK.

Returns:

The drive detection mode specified for the Zendrive SDK.

getDriverAttributes

public ZendriveDriverAttributes getDriverAttributes()

Returns the additional attributes of the current driver.

Returns:

Returns the additional attributes of the current driver if set. Null otherwise.

setDriverAttributes

public void setDriverAttributes(ZendriveDriverAttributes driverAttributes)

Set the additional attributes of the current driver.

Parameters:

driverAttributes - The additional attributes of the current driver. If null, all the driver attributes are reset.

setDriveDetectionMode

public void setDriveDetectionMode(ZendriveDriveDetectionMode mode)

Set the drive detection mode of this configuration.

Parameters:

mode - The ZendriveDriveDetectionMode.

getRegion

public ZendriveRegion getRegion()

Returns the region associated with the current driver.

setRegion

public void setRegion(ZendriveRegion region)

Set the region type of this configuration.

Parameters:

region - The ZendriveRegion.

getImplementsMultipleAccidentCallbacks

public boolean getImplementsMultipleAccidentCallbacks()

Returns a boolean indicating if the app supports receiving multiple callbacks.

getEnabledBluetoothDriveStart

public boolean getEnabledBluetoothDriveStart()

Returns a boolean indicating if the app supports Bluetooth Drive Start.

setImplementsMultipleAccidentCallbacks

public void setImplementsMultipleAccidentCallbacks(boolean implementsMultipleAccidentCallbacks)

Set this property to true if the app supports receiving multiple callbacks.

If set to true, the application will receive ZendriveBroadcastReceiver.onPotentialAccident(android.content.Context, com.zendrive.sdk.AccidentInfo). This callback can serve as an early indication of a collision that might have happened. A potential accident event sent this way might be invalidated by the final callback in ZendriveBroadcastReceiver.onAccident(android.content.Context, com.zendrive.sdk.AccidentInfo). Such a callback will have AccidentInfo.confidenceNumber set to 0 and AccidentInfo.confidence set to INVALID.

Default value is false.

setEnabledBluetoothDriveStart

public void setEnabledBluetoothDriveStart(boolean enabledBluetoothDriveStart)

Set this property to true if the app supports Bluetooth Drive Start.

If set to true, the application will receive ZendriveBroadcastReceiver.onDriveStart(android.content.Context, com.zendrive.sdk.DriveStartInfo) callback whenever a successful bluetooth connection is established with an already associated vehicle. If the vehicle is not already associated, call ZendriveVehicleTagging.associateVehicle(android.content.Context, com.zendrive.sdk.ZendriveVehicleInfo) before connecting the device to the vehicle via Bluetooth. This feature needs ZendriveDriveDetectionMode to be ZendriveDriveDetectionMode.AUTO_ON.

Default value is false. Please contact Zendrive Support in case the feature is not enabled.

Parameters:

enabledBluetoothDriveStart -

toJson

public JSONObject toJson()

Return the json representation of this object. Null if a json exception occurred.

Returns:

the json representation of this object. Null if a json exception occurred.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object