Requirements
The Extole iOS SDK supports iOS 13.0 and later.Integration
Swift Package Manager
- Open your project in Xcode
- Go to: File → Add Packages…
- Enter the repository URL: https://github.com/extole/ios-sdk
- Choose the latest version
- Add the package to your target
Initialize SDK
In yourAppDelegate class, initialize Extole. You’ll need to provide your Extole program domain.
AppDelegate
For a working example, please reference ourGithub documentation. For more detailed configuration options, see the Advanced Usage section.
Initialize View
In yourmain method, pass Extole to your view.
main
For a working example, please reference ourGithub documentation.
Initialize the View provided by Extole. By default, Extole will use this single view to interact with the customer.
View
Exchange Data with Extole
Send Customer Information
Send Extole information about the customer.mobile_cta
You can choose to pass any type of data to describe the customer. Richer data about your customers gives your marketing team the information they need to better segment your program participants and target them with appropriate campaigns.
JWT Identification
If you would like to verify the identity of your customers with JWT instead of their email address, use the following method:image
For more information on generating JWTs, please reference our article on Verifying Consumers.
Send Events
Send Extole events, such as registers, signups, conversions, account openings, and so on.title
For each event type, you can send additional data. For example, on a conversion event you may want to pass in order ID or order value and so on.
Send Call to Action Content
Populate a CTA with content from Extole. CTAs such as mobile menu items can be fully customized in the My Extole Campaign Editor. Each CTA has a designated zone. The following code is an example of how to retrieve a CTA by fetching zone content.mobile_bootstrap
For a working example, please reference ourGithub documentation.
In order to be able to fetch the mobile_cta zone, the zone should be configured in My Extole and should return JSON content containing the image and title.
Important NoteWe encourage you to pull CTA content from My Extole because doing so ensures that your menu item or overlay message will reflect the copy and offer you’ve configured for your campaign.
Advanced Usage
The following topics cover advanced use cases for the Extole iOS SDK. If you would like to explore any of these options, please reach out to our Support Team at support@extole.com.Integrate with a Deep Link Provider
Completing a deep link integration is simple once you have integrated with a deep link provider, such as Branch. Send a mobile event to Extole and, based on the configuration of your mobile operations, our framework will execute the corresponding action.PROMPT
Configure Actions from Events
You can set up a specific action to occur when an event is fired. For example, when a customer taps on your menu item CTA, you may want the event to trigger an action that loads your microsite and shows the share experience. To set up this type of configuration, you will need to work with Extole Support to set up a zone in My Extole that returns JSON configurations with conditions and actions. The SDK executes actions for conditions that are passing for a specific event.NATIVE_SHARING
Adding additional operationsIf you would like to add more operations, you will need to update the zone
mobile_bootstrap. By default, this zone is not available to be updated. You must have already added the mobile SDK support component. Please reach out to our Support Team at support@extole.com for help adding this component to your campaign.Supported Actions
The following types of actions are supported by default in our SDK.Custom Actions
If you would like to create custom actions beyond our defaults, use the format exhibited in the example below. Please reach out to our Support Team at support@extole.com if you have any questions.VIEW_FULLSCREEN
Register Custom Actions
sw