CleverTap iOS SDK

The CleverTap iOS SDK for App Analytics and Engagement

CleverTap combines real-time customer insights, an advanced segmentation engine, and powerful engagement tools into one intelligent marketing platform.

For more information check out our website and documentation.

Setup

Sign Up

Sign up for a free account.
Install the Framework

Starting with v3.0.0, the SDK adds support for App Extensions and watchOS apps. Starting with v3.1.3, the SDK adds support for tvOS.
- Install Using CocoaPods
  
  For your iOS, App Extension target(s) and tvOS app, add the following to your Podfile:
```
target 'YOUR_TARGET_NAME' do  
    pod 'CleverTap-iOS-SDK'  
end     
```
  If your main app is also a watchOS Host, and you wish to capture custom events from your watchOS app, add this:
```
target 'YOUR_WATCH_EXTENSION_TARGET_NAME' do  
    pod 'CleverTapWatchOS'  
end
```
  Also, you will need to enable the preprocessor macro via your Podfile by adding this post install hook:
```
post_install do |installer_representation|
    installer_representation.pods_project.targets.each do |target|
        target.build_configurations.each do |config|
            config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 
            'CLEVERTAP_HOST_WATCHOS=1']
        end
   end
end
```
  Then run pod install.
- Install Using Carthage
  
  CleverTap also supports Carthage to package your dependencies as a framework.
  
  To integrate CleverTap into your Xcode project using Carthage, specify it in your Cartfile:
```
github "CleverTap/clevertap-ios-sdk"
```
  Run carthage update to build the framework and drag the built CleverTapSDK.framework into your Xcode project.
  
  Also, follow steps to link SDWebImage into your project
  - In your Project, go to Carthage folder
  - Select clevertap-ios-sdk under Checkouts
  - Drag the built SDWebImage.framework from Vendors into your Frameworks and Libraries
- Manually Install the Framework
  
  For just the basic SDK functionality in your main app:
  - Download the latest framework release. Unzip the download.
  - Add the CleverTapSDK.xcodeproj to your Xcode Project, by dragging the CleverTapSDK.xcodeproj under the main project file.
  - Embed the framework. Select your app.xcodeproj file. Under "General", add the CleverTapSDK framework as an embedded binary
Add Your CleverTap Account Credentials

Update your .plist file:
- Create a key called CleverTapAccountID with a string value
- Create a key called CleverTapToken with a string value
- Insert the values from your CleverTap Dashboard -> Settings -> Integration Details.

For more details, Please refer to our installation guide for instructions on installing and using our iOS SDK in your project.

Example Usage

A demo application showing the integration of our SDK in Objective-C language.
A demo application showing the integration of our SDK in Swift language.

Changelog

Check out the CleverTap iOS SDK Change Log here.

Questions?

If you have questions or concerns, you can reach out to the CleverTap support team at [email protected].

License

Check out the CleverTap iOS SDK License here.

ygit / clevertap-ios-sdk Goto Github PK