The Gini Capture SDK has the ability to track user events. In order to receive the events, implement the
GiniCaptureTrackingDelegate protocol and supply the delegate when initializing Gini Capture SDK. For example:
let viewController = GiniCapture.viewController(withClient: client, importedDocuments: visionDocuments, configuration: captureConfiguration, resultsDelegate: self, documentMetadata: documentMetadata, trackingDelegate: trackingDelegate) // Or when not using the default network implementation pod GiniCapture/Networking: let viewController = GiniCapture.viewController(withDelegate: self, withConfiguration: captureConfiguration, importedDocument: nil, trackingDelegate: trackingDelegate)
Event types are partitioned into different domains according to the screens that they appear at. Each domain has a number of event types. Some events may supply additional data in a dictionary. Certain events pertaining to transitions between screens are only reported in the Screen API.
|Domain||Event type||Additional info keys||Comment||Screen API||Compoment API|
||User completed onboarding||✅||✅|
||User closed the camera screen||✅||❌|
||User tapped “Help” on the camera screen||✅||❌|
||User took a picture||✅||✅|
||User went back from the review screen||✅||❌|
||User advanced from the review screen||✅||❌|
||User canceled the process during analysis||✅||❌|
||The analysis ended with an error. The error message is supplied under the “message” key.||✅||✅|
||The user decided to retry after an analysis error.||✅||✅|
If you are using the Component API, you may want to implement the remaining events in your coordinator code. In order to report an event, call the
GiniCaptureTrackingDelegate method relating to the event’s domain area and pass the event.
For instance to report user advancing from the Review Screen, call
onReviewScreenEvent(event:) passing an
ReviewScreenEventType defines the event types available in the Review Screen domain.
The call would look something like this:
trackingDelegate?.onReviewScreenEvent(event: Event(type: .next))