The SDK Platform: Showing Templates in-app
In this article:
- What is an SDK?
- Customizing and configuring the SDK platform.
- Setting up the Delighted SDK — Developers' Guide.
- Previewing the Delighted SDK survey.
- Testing the SDK platform.
- What are the benefits of using the Delighted SDK?
- What operating systems are supported?
- Can I make adjustments once my Template is live?
Suggested next article: CocoaPods
What is an SDK?
Your app affords a tremendous opportunity to surface customer feedback — in real time.
Delighted's SDK is a set of tools for developers to help integrate Templates into your iOS app. Instead of hammers and nails, our SDK toolkit includes:
- Accessible and updated documentation
- Helpful code samples
- Debugging tools
- Clear versioning
- And more!
Is the Delighted SDK a solid solution for your needs?
Implementing the Delighted SDK is a straightforward process. Still, there are two prerequisites:
- Does your company have an iOS app?
- Is there a software developer with the necessary bandwidth?
If the answer is yes, then the Delighted SDK is a good bet!
Keeping developers in mind
Leveraging countless SDKs ourselves, made us highly conscious of the developer experience. Consequently, it's our commitment to make our SDK one of the best available.
Our team was hyper focused on creating a dependable SDK that is instructive, not limiting, and enjoyable to work with.
Are you a developer?
Feel free to review this next section for context, or skip to our technical documentation.
Customizing and configuring the SDK platform
Getting your SDK Template survey customized takes just a few minutes, and involves setting a handful of configurations around branding, survey copy, and survey placement behavior.
To start the configuration process:
1. Click on “Survey people” → and choose “Set up” under the iOS SDK platform tile
3. Adjust your visual customizations → and click "Save changes." (For details, see Templates Customization Basics and Quick Start Video)
|Brand/product name||Set the brand or product name used in the survey question|
|Brand color||Set the color of the survey buttons|
|Presentation style||Set either a centered modal or a card popping up from the bottom of the screen|
|Presentation shape||Set either rounded or squared corners for the survey display|
|Button style||Set the style of the survey buttons (ex. filled or outlined)|
|Button shape||Set the shape of the survey buttons|
|Question customization||Set the question prompted to users in-app|
|Advanced customization||Set the language of the survey|
If you're using an icon-based survey type, such as Smileys or 5-star, the button style won't affect your first question. However, it will affect any Additional Questions that you may add!
We offer a number of turnkey configurations for surveying visitors to your app.
|Survey a user of your app once||Survey a sample of app users, either focusing on all users, or only those who are returning. We’ll survey customers once, and then never again|
|Periodically survey users of your app||Survey app users either immediately, or at a delay, after subscription with your service. Since you may want a constant pulse of feedback from your customer base, this configuration offers an optional recurring survey to app users on a regular, ongoing basis (ex. every 3 months)|
|Survey a user after a transaction or event||Survey all app users that land on a particular page of your app. We recommend placing it on a post-transaction page — such as where you show a receipt after a purchase|
Click "Turn on"
Don't forget to click the Turn on button! If that isn't enabled, your Mobile SDK Template will not display.
Setting up the Delighted SDK — Developers' Guide
Finishing the setup of Delighted's SDK requires just a few steps — including importing a framework and installing the applicable code to your app. Also, as with any SDK app build, you'll want to effectively test, debug, and continue to refine your iOS surveys over time.
Please take note of the requirements below.
Requirements for Installation
- Xcode 10.1
- Apps targeting iOS 11.0 or greater
- Note: The Delighted SDK is designed for iPhone's portrait mode. Support for other iOS devices is not available at this time
- Swift 4
- Swift 4.2
- Swift 5
- Starscream (Used for WebSocket support)
You'll use CocoaPods to finalize your setup of the SDK. CocoaPods is a package dependency manager, which makes it easy to add, remove, and update libraries that are critical for the development of iOS applications. The full details for installation with CocoaPods can be found here.
Previewing the Delighted SDK survey
The Delighted SDK platform gives you the ability to view the survey on your actual mobile device (as opposed to a rendering on our website). With this advanced preview, your team will be able to view, fine-tune, and interact with the mobile survey.
To preview your SDK Template survey's customization, download the Delighted iOS app. Log into Delighted, so the next steps are as seamless as possible and then head to your customization section for the iOS SDK:
Grab your iOS device and follow these steps:
- Open the Camera app
- Using the rear-facing camera:
- Position the viewfinder so the QR code is fully in frame and sharp
- Your iOS device will recognize the QR code and display a notification
- Tap the notification → and open the Delighted link associated with the QR code
You're all set to preview on your iOS device!
Testing the SDK platform
With Delighted's SDK, there are a number of conditional checks around eligibility (ex. throttling, delays, etc.) that are applied prior to rendering the survey in-app. During testing stages, it can be helpful to bypass those conditions to force a display and view the survey immediately.
To bypass the previously noted conditional checks, use
testMode which is a parameter that will force the user to bypass all checks and will result in the surveying appearing:
let eligibilityOverrides = EligibilityOverrides( testMode: true ) Delighted.survey(delightedID: "mobile-sdk-xxxxxxxxx", eligibilityOverrides: eligibilityOverrides)<br>
To remove any responses collected during the testing phase, ask any account Admin to tackle the deletions from the Permalink pages.
What are the benefits of the Delighted SDK?
Delighted's SDK offers the easiest and fastest paths for integrating Delighted Templates within your app environment. No need to spend excessive engineering bandwidth on development or require expertise on the Delighted platform.
Here are just a few of the benefits your development team will actualize by leveraging the Delighted SDK:
|Faster time-to-market:||Delighted's SDK has done the heavily lifting for you! By providing a complete solution and a curated collection of resources, developers can roll-out integrations in a fraction of the time it would take with standard API integrations|
|Ongoing cost savings:||With less development, testing, and implementation time required with the Delighted SDK, in-app integration of Delighted surveys will remain cost effective|
|Ease of integration:||Delighted's SDK is a comprehensive, one-stop solution for quickly building your Template program into your app framework. Need to reference some sample code for a solid starting point? We have you covered. Looking for more in-depth installation instructions? We have that too!|
|Collaborative developer community:||Delighted's SDK is open source! With more developers iterating on Delighted's SDK, you can expect to see more and more implementations for unique use cases and solutions, heightened transparency via peer review, and an evolving set of technical resources to get started!|
Benefits of using in-app surveys
Delighted's SDK creates an opportunity to run in-app surveys. Here's two additional benefits worth a mention:
|Easy to manage for non-technical team members||The ongoing management of in-app surveys are controlled via the Delighted Templates UI, so developer support is rarely required after the initial setup. Even your least technically team member can run your in-app surveys!|
|Diversified survey channels for more comprehensive coverage||Meet your app customers where they're most likely to provide feedback, expanding beyond your existing feedback arsenal (along with Web or email) for a more accurate and complete picture of the customer experience|
SDK in-app use cases
Delighted's SDK makes it super simple to blend surveys seamlessly into your app experience, collecting feedback in a way that feels more like an extension of your app rather than an interruption. You'll unlock a degree of contextual feedback that is miles beyond what would historically be possible with traditional Web and Email surveys — meeting customers in your app, where they're most likely to be interacting with your product/brand on a regular basis.
With the SDK, your team can roll-out in-app surveys to cover a range of use cases:
- Gather contextual feedback about the app and in-app features to influence your product roadmap
- Identify and address dissatisfied customers early, providing an opportunity for outreach prior to your app users dropping negative public-facing feedback
- Blend in CTAs to push your most enthusiastic and satisfied customers to app stores, review pages, and other third-party apps
- Treat surveys as a feature of the app, such as a Learning Management System (LMS) prompting students to evaluate each course
These use cases just scratch the surface of what's truly possible with our full development kit at your team's disposal. Delighted surveys have never been more adaptable to your team's requirements — providing a truly frictionless way to capture feedback in your app.
What operating systems are supported?
Presently, Delighted's SDK is supported by iOS devices. Reach out to us if you'd like to be notified of upcoming Android support.
Can I make adjustments once my Template is live?
Adjustments made in the dashboard will be reflected in your iOS app in near real-time. If you're overriding any Options shown above, you'll need to make updates to that code specifically (i.e., adjustments in the UI will continue to be overridden by the custom code).