LookbackParticipate
IntroductionBy setting up Participate for your app, you prepare your app for receiving "Participate URLs", and allows it to be used in UX research. Participate is a UI layer on top of of the `LookbackRecorder`, so that Lookback can take care of the full research flow for you. The Participate flow is completely self contained, so once implemented, you do not need to use the `LookbackRecorder` or any other SDK API. Discussion# INSTALLATION GUIDE To use Participate inside your app:
You're done! Now whenever a user taps a Participate link targeted for your app, your app will launch and a research session will be started. # EXAMPLE INTEGRATION class AppDelegate: UIResponder, UIApplicationDelegate { var window: UIWindow? var participate: LookbackParticipate! func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { participate = LookbackParticipate() participate.setup(withApplicationWindow: self.window!) return true } func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool { return participate.startParticipation(from: url) } }
# USAGE FLOW The usage flow, all the way from integration to completed research using the Participate SDK is as follows:
Methods
-setupWithApplicationWindow:Call from your app delegate's -[application:didFinishLaunchingWithOptions:] to enable Participate in your app. - (void)setupWithApplicationWindow:(UIWindow*)applicationWindow; DiscussionIf there are pending actions from last time the app ran (such as finishing an upload), this method will display this UI modally in a separate window. Not calling this at app startup can lead to research not finishing or not uploading properly.: See Also -startParticipationFromURL:This method inspects the incoming URL, and if it looks like a Participate URL (as vended by the lookback.io web dashboard, either a "live" or a "self-test" link), it presents UI in an overlay window to guide the user through a research session. - (BOOL)startParticipationFromURL:(NSURL*)participateURL; DiscussionCall this method from your application's -application:openURL:options:. You can send in any URL, and it will only return YES/true if it is a proper Participate URL. If you handle other types of URLs in your app, make sure to handle Participate URLs first, like so:
See Also setupWithApplicationWindow:Call from your app delegate's -[application:didFinishLaunchingWithOptions:] to enable Participate in your app. - (void)setupWithApplicationWindow:(UIWindow*)applicationWindow; DiscussionIf there are pending actions from last time the app ran (such as finishing an upload), this method will display this UI modally in a separate window. Not calling this at app startup can lead to research not finishing or not uploading properly.: See Also startParticipationFromURL:This method inspects the incoming URL, and if it looks like a Participate URL (as vended by the lookback.io web dashboard, either a "live" or a "self-test" link), it presents UI in an overlay window to guide the user through a research session. - (BOOL)startParticipationFromURL:(NSURL*)participateURL; DiscussionCall this method from your application's -application:openURL:options:. You can send in any URL, and it will only return YES/true if it is a proper Participate URL. If you handle other types of URLs in your app, make sure to handle Participate URLs first, like so:
See Also |