Protocol

RFEventListener

Protocol to be implemented by host application to customize action for various SDK events

Declaration

protocol RFEventListener

Overview

This protocol must be implemented by host application’s own EventListener class that has customized action for each of the methods. When certain event occurs in the SDK system, SDK notifies the host app by triggering the RFEventLisetner instance passed by the host application.

Related Topic: initialize(hostVC:uid:initLocation:eventListener:initResultListener:)

Topics

Instance Methods

func onDownloadModelWithoutWifi(downloadRequired: Bool)
Triggered when Signature Model download is required but user is not on wifi. Host application should prompt the user to download the model on the local network. (downlod can be done by calling RideFlagProvider.downloadModel)
func onExitRewardPolygon(exitAuditCandidatePhoto: UIImage?)
Triggered when the user has exited the reward polygon of the reward granted
func onIncentiveGranted(reward: RFReward, auditRequired: Bool)
Triggered when a reward is granted to the user.
func onIncentiveInRange(reward: RFReward)
Triggered when there is an incentive found around the location provided.
func onIncentiveRejected(reward: RFReward)
Triggered when a reward is claimed but the RideFlag SDK did not granted reward to the user.
func onNewIncentiveListed(rewardMarkers: [RFRewardMarker])
Triggered when new incentives are found near location provided. Host application is expected to display or notify these rewardMarkers to the user.
func onTripNotMoving(msg: String)
Triggered when user seems to not be moving for a while
func onTripRecovered(tripId: String, reward: RFReward)
Trigggered when trip is recovered. (found a trip that is started but not finished)