Home

⚠️ This Wiki is deprecated.

Please refer the official documentation.

Blueshift-iOS-SDK

Blueshift recently launched its mobile SDK to make it easier for marketers to integrate their mobile app with Blueshift’s near real-time event processing platform and send personalized rich push notifications to their customers.

The current version of the SDK supports the following features:

1. Native ability to render push notifications. The SDK currently supports the following formats:
   • Banner and lock screen push notifications for Android and iOS
   • Image based push notifications for Android
   • Interactive push notifications - Include to call to actions buttons right within your push notifications
   • Alert box notifications for Android and iOS (coming soon)
   • Send rich push notifications with custom landing pages, images etc.
2. Ability to send custom JSON directly to your app.
3. Comprehensive Stats on Push Campaigns - Measure deliverability/views, clicks, orders and revenue for push campaigns.
4. Track daily un-installs by running pre-configured silent push campaigns.
5. Ready integration for basic events like Identity, Product View, Add to Cart, Checkout, Purchase, App Install
6. Easy single method integration to send custom events relevant to your app
7. Native support to send to events real-time or in batches
8. Sync sending of batch events with Android Alarm manager to ensure optimal battery and network consumption by your app (Available only for Android)

Integration

Step 1: Download CocoaPods

CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries.

CocoaPods is distributed as a ruby gem, and is installed by running the following commands in Terminal.app:

$ sudo gem install cocoapods
$ pod setup

Depending on your Ruby installation, you may not have to run as sudo to install the cocoapods gem.

Step 2: Create a Podfile

Project dependencies to be managed by CocoaPods are specified in a file called Podfile. Create this file in the same directory as your Xcode project (.xcodeproj) file:

$ touch Podfile
$ open -a Xcode Podfile

You just created the pod file and opened it using Xcode!

Copy and paste the following lines into the Xcode window:

platform :ios, '7.0'

target 'APP NAME TARGET' do
  pod 'BlueShift-iOS-SDK'
end

If you are using Swift, create bridge-header for your app and import following header

#import <BlueShift-iOS-SDK/BlueShift.h> 

If you are integrating attachment media type push notification with Notification Service Extension (for iOS 10 and above) add following lines too

target 'APP EXTENSION TARGET NAME' do
  pod 'BlueShift-iOS-Extension-SDK'
end

@ Deprecated

If you are using Cocoapod version 1.1 below you can use following way of integration, since version 1.1 onward it doesn't support.

target 'APP EXTENSION TARGET NAME' do
  pod 'BlueShift-iOS-SDK/AppExtension'
end

Step 3: Install Dependencies

Now you can install the dependencies in your project by Terminal:

$ pod install

From now on, be sure to always open the generated Xcode workspace (.xcworkspace) instead of the project file when building your project (.xcodeproj):

$ open <ProjectName>.xcworkspace

Next [Setup SDK] (https://github.com/blueshift-labs/Blueshift-iOS-SDK/wiki/Setup-SDK)