Inherits from NSObject
Conforms to NSCopying
Declared in ZendriveConfiguration.h

Overview

This class contains parameters required by Zendrive during setup.

Tasks

Properties

accidentDetectionMode

Specify ZendriveAccidentDetectionModeEnabled to enable detection of accidents by the Zendrive SDK and receive realtime callbacks for the same. This feature is available only to premium account holders. Please refer to https://developers.zedrive.com for further details.

@property (nonatomic, assign) ZendriveAccidentDetectionMode accidentDetectionMode

Discussion

Specify ZendriveAccidentDetectionModeEnabled to enable detection of accidents by the Zendrive SDK and receive realtime callbacks for the same. This feature is available only to premium account holders. Please refer to https://developers.zedrive.com for further details.

Please refer to [Zendrive isAccidentDetectionSupportedByDevice] to check whether accident detection would work on the device or not.

Warning: Property ignored. It is always set to ZendriveAccidentDetectionModeEnabled.

Declared In

ZendriveConfiguration.h

applicationKey

Your application key.

@property (nonatomic, strong, nonnull) NSString *applicationKey

Discussion

Pass in the application key for your app. If you don’t have one, please create one at https://developers.zendrive.com/signup

This field is REQUIRED and should be a valid string. Check [Zendrive isValidInputParameter:] to validate this field. Nil strings are not allowed. Passing invalid string would cause SDK setup to fail.

Declared In

ZendriveConfiguration.h

driveDetectionMode

Use this mode to control the SDK’s behaviour for detecting drives automatically. This mode can be changed at a later point using [Zendrive setDriveDetectionMode:] method.

@property (nonatomic, assign) ZendriveDriveDetectionMode driveDetectionMode

Discussion

Applications which do not want the SDK to continuously track drives in background should set this value to ZendriveDriveDetectionModeAutoOFF. With this, the application needs to call startDrive: 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 method [Zendrive setDriveDetectionMode:] to change the mode to ZendriveDriveDetectionModeAutoON for that period and set it back to ZendriveDriveDetectionModeAutoOFF (once the driver goes off-duty).

Declared In

ZendriveConfiguration.h

driverAttributes

Attributes for the current user. These attributes are stored on the server and are provided in Zendrive’s APIs. Any existing attributes would be overwritten on the server when a non-nil value for this param is passed. Passing nil is a no-op.

@property (nonatomic, strong, nullable) ZendriveDriverAttributes *driverAttributes

Discussion

Use this param to provide meta-information about the user like name, email, groupId or any custom attributes you wish to provide. Default value is nil.

Declared In

ZendriveConfiguration.h

driverId

Unique ID for the current user. This can be any ID used by your app to identify its users. This is the ID which will be used in Zendrive reports. Use [Zendrive isValidInputParameter:] to verify that userId is valid.

@property (nonatomic, strong, nonnull) NSString *driverId

Discussion

This field is REQUIRED and should be a valid string. Check [Zendrive isValidInputParameter:] to validate this field. Nil strings are not allowed. Passing invalid string would cause SDK setup to fail.

Declared In

ZendriveConfiguration.h

operationMode

You should assign a value to this property that is appropriate for your usage scenario. For example, if you need only drive start/end detection with coarse distance and waypoints, use ZendriveOperationModeDriveTracking.

@property (nonatomic, assign) ZendriveOperationMode operationMode

Discussion

Refer to ZendriveOperationMode documentation for choosing a mode which suits your application requirements. Once setup, all drives detected by the SDK would be in the specified operationMode. If you wish to change the operation mode at any point, you need to call [Zendrive teardownWithCompletionHandler:] and setup the SDK again.

Warning: Property ignored. It is always set to ZendriveOperationModeDriverAnalytics.

Declared In

ZendriveConfiguration.h