ZendriveDelegate
@objc(ZDZendriveDelegate)
public protocol ZendriveDelegate : NSObjectProtocol
Delegate for Zendrive
.
-
Called on delegate in the main thread when
Zendrive
SDK detects a potential start of a drive.Declaration
Swift
@objc optional func processStart(ofDrive startInfo: DriveStartInfo)
Parameters
startInfo
Info about drive start. Refer to
DriveStartInfo
for further details. -
Called on delegate in the main thread when
Zendrive
SDK resumes a drive after a gap.The gap in drive recording may occur due to an application restart by the OS, application kill and restart by a user, an application crash or other reasons. Drives started by calling
Zendrive.startManualDrive(_:completionHandler:)
are always resumed and they will not end untilZendrive.stopManualDrive(_:)
is called.Declaration
Swift
@objc optional func processResume(ofDrive resumeInfo: DriveResumeInfo)
Parameters
resumeInfo
Info about drive resume. Refer to
DriveResumeInfo
for further details. -
Called on the delegate in the main thread when
Zendrive
SDK detects a drive to have been completed.It is possible that
Zendrive
SDK might decide at a later time that an ongoing trip was a falsely detected trip. In such scenarioprocessEnd(ofDrive:)
will be invoked on delegate withDriveInfo
.driveType set toDriveType.invalid
.Every trip with
DriveInfo
.driveType not set toDriveType.invalid
will receive a correspondingprocessAnalysis(ofDrive:)
callback containing additional info related to this drive.Declaration
Swift
@objc optional func processEnd(ofDrive estimatedDriveInfo: EstimatedDriveInfo)
Parameters
estimatedDriveInfo
Best estimate info about the drive. Refer to
EstimatedDriveInfo
for further details. -
Called on the delegate in the main thread when
Zendrive
SDK finishes full analysis of all valid drives returned fromprocessEnd(ofDrive:)
callback.This will be called for all the
processEnd(ofDrive:)
callbacks with the value ofDriveInfo
.driveType not set toDriveType.invalid
.This may contain additional or improved data over the
EstimatedDriveInfo
returned fromprocessEnd(ofDrive:)
Typically this callback will be fired within a few seconds after
processEnd(ofDrive:)
callback but in some rare cases this delay can be really large depending on phone network conditions.This callback will be fired in trip occurrence sequence, i.e from oldest trip to the latest trip.
Declaration
Swift
@objc optional func processAnalysis(ofDrive analyzedDriveInfo: AnalyzedDriveInfo)
Parameters
analyzedDriveInfo
Analyzed insights of the drive.
-
[Disabled by default] This callback is fired on the main thread when a potential accident is detected by the SDK during a drive. This is a preliminary callback of a potential collision. This collision is confirmed or invalidated by
processAccidentDetected(_:)
callback.To enable contact: support@zendrive.com
Declaration
Swift
@objc optional func processPotentialAccidentDetected(_ accidentInfo: AccidentInfo)
Parameters
accidentInfo
Info about accident.
-
This callback is fired on the main thread when an accident is detected by the SDK during a drive. Any ongoing auto-detected/manual drives will be stopped after this point.
Declaration
Swift
@objc optional func processAccidentDetected(_ accidentInfo: AccidentInfo)
Parameters
accidentInfo
Info about accident.
-
Warning
This callback is deprecated. UsesettingsChanged(_:)
callback instead.This callback is fired on main thread when location services are denied for the SDK. After this callback, drive detection is paused until location services are re-enabled for the SDK.
The expected behaviour is that the enclosing application shows an appropriate popup prompting the user to allow location services for the app.
The callback is triggered once every time location services are denied by the user and can be triggered in background or in foreground, depending on whether the SDK has enough CPU time to execute.
This callback is not sent if
Configuration.managesLocationPermission
value was set tofalse
at setup.Declaration
Swift
@available(*, deprecated, message: "Use `settingsChanged(_:﹚` callback instead.") @objc optional func processLocationDenied()
-
Warning
This callback is deprecated. UsesettingsChanged(_:)
callback instead.This method is called when location permission state is determined for the first time or whenever it changes. This callback is not sent if
Configuration.managesLocationPermission
value was set tofalse
at setup.Declaration
Swift
@available(*, deprecated, message: "Use `settingsChanged(_:﹚` callback instead.") @objc optional func processLocationApproved()
-
Warning
This callback is deprecated. UsesettingsChanged(_:)
callback instead.This callback is fired if activity and fitness permission is denied for the SDK. This callback is not sent if
Configuration.managesActivityPermission
value was set tofalse
at setupDeclaration
Swift
@available(*, deprecated, message: "Use `settingsChanged(_:﹚` callback instead.") @objc optional func processActivityDenied()
-
Warning
This callback is deprecated. UsesettingsChanged(_:)
callback instead.This callback is fired if activity and fitness permission is approved for the SDK. This callback is not sent if
Configuration.managesActivityPermission
value was set tofalse
at setupDeclaration
Swift
@available(*, deprecated, message: "Use `settingsChanged(_:﹚` callback instead.") @objc optional func processActivityApproved()
-
This callback gives information about errors in device or application settings that may be affecting Zendrive SDK.
This callback is fired on the main thread after SDK setup and whenever location permission or
Configuration.driveDetectionMode
changes, provided the location permission is determined.The recommended flow is to ask for the permissions before SDK is setup because if the location permission is not determined this callback will not be fired.
If you receive this callback in the foreground you can show the errors using any UI constructs like alert controllers, if this callback is received in the background you can use a notification. If you want to add actions to the notification then please don’t rely on errors received at the time of notification as they might have changed by the time the user clicks on the notification. Instead use
Zendrive.getSettings()
to get the latest errors and show appropriate message to the user.Declaration
Swift
@objc optional func settingsChanged(_ settings: Settings)