Push Story Setup
The Push Story feature requires UNNotification Framework and iOS 10. The feature is only available from iOS SDK version 3.2.1.
Step 1: Enable Push In Your App
Please follow The Push notification Integration to enable push in your app.
Step 2: Adding the Notification Content Extension Target
In your app project, go to menu “File”->”New”->”Target…”, add a new “Notification Content Extension” target and activate it.
Xcode should generate a new target for you and create files automatically for you including:
NotificationViewController.h
NotificationViewController.m
MainInterface.storyboard
NotificationViewController.swift
MainInterface.storyboard
Step 3: Enable Capabilities
The Background Mode in the Capabilities section of the main app target is required by the Push Story feature. After turn on the background modes, select “Background fetch” and “Remote Notification”.
You also need to add Capability App Groups
. If you haven’t had any app group in your app, go to the Capability of the main app target, turn on the App Groups
and click the “+”. Use your App’s bundle ID to create the App Group. For example, if your app’s bundle ID is com.company.appname
, you can name your App Group group.com.company.appname.xyz
. You need to turn on the App Groups
for both the main app target and the content extension target.
Step 4: Adding the Push Story framework to your app
Swift Package Manager
After following the Swift Package Manager integration guide, simply add AppboyPushStory
to your Notification Content Extension:
Cocoapods
Add the following line to your Podfile:
1
2
3
target 'YourContentExtensionTarget' do
pod 'Appboy-Push-Story'
end
After updating the Podfile, navigate to the directory of your Xcode app project within your terminal and run pod install
Manual Integration
Download the latest AppboyPushStory.zip
from the Github release page, unzip it and add the following files to your project’s Notification Content Extension:
Resources/ABKPageView.nib
AppboyPushStory.xcframework
Make sure that Do Not Embed
is selected for AppboyPushStory.xcframework
under the Embed
column.
Add the -ObjC
flag to your project’s Notification Content Extension in Build Settings->Other Linker Flags.
Step 5: Updating your Notification View Controller
In your NotificationViewController.h
, add following lines to add new properties and import the header files:
1
#import <AppboyPushStory/AppboyPushStory.h>
1
2
@property (nonatomic) IBOutlet ABKStoriesView *storiesView;
@property (nonatomic) ABKStoriesViewDataSource *dataSource;
In your NotificationViewController.m
, remove the default implementation and add following code:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
@implementation NotificationViewController
- (void)didReceiveNotification:(UNNotification *)notification {
self.dataSource = [[ABKStoriesViewDataSource alloc] initWithNotification:notification
storiesView:self.storiesView
appGroup:@"YOUR-APP-GROUP-IDENTIFIER"];
}
- (void)didReceiveNotificationResponse:(UNNotificationResponse *)response
completionHandler:(void (^)(UNNotificationContentExtensionResponseOption option))completion {
UNNotificationContentExtensionResponseOption option = [self.dataSource didReceiveNotificationResponse:response];
completion(option);
}
- (void)viewWillDisappear:(BOOL)animated {
[self.dataSource viewWillDisappear];
[super viewWillDisappear:animated];
}
@end
In your NotificationViewController.swift
, add following line to import the header files:
1
import AppboyPushStory
Next, remove the default implementation and add following code:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class NotificationViewController: UIViewController, UNNotificationContentExtension {
@IBOutlet weak var storiesView: ABKStoriesView!
var dataSource: ABKStoriesViewDataSource?
func didReceive(_ notification: UNNotification) {
dataSource = ABKStoriesViewDataSource(notification: notification, storiesView: storiesView, appGroup: "YOUR-APP-GROUP-IDENTIFIER")
}
func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) {
if dataSource != nil {
let option: UNNotificationContentExtensionResponseOption = dataSource!.didReceive(response)
completion(option)
}
}
override func viewWillDisappear(_ animated: Bool) {
dataSource?.viewWillDisappear()
super.viewWillDisappear(animated)
}
}
Step 6: Set the Notification Content Extension Storyboard
- Open the Notification Content Extension storyboard and place a new
UIView
in the notification view controller. Rename the class toABKStoriesView
. Make the view width and height auto-resizable matching the Notification View Controller’s main view frame.
- Link the Notification View Controller’s
storiesView
IBOutlet to the addedABKStoriesView
.
Step 7: Set the Notification Content Extension Plist
Open the Info.plist file of the Notification Content Extension and add/change following keys under NSExtension \ NSExtensionAttributes
:
UNNotificationExtensionCategory
= ab_cat_push_story_v2
(String
type)
UNNotificationExtensionDefaultContentHidden
= YES
(Boolean
type)
UNNotificationExtensionInitialContentSizeRatio
= 0.65
(Number
type)
Step 8: Updating the Braze Integration in Your Main App
Option 1: Runtime
In the appboyOptions
dictionary used to configure your Braze instance, add a ABKPushStoryAppGroupKey
entry and set the value to your App Group identifier.
1
2
3
4
5
6
NSMutableDictionary *appboyOptions = [NSMutableDictionary dictionary];
appboyOptions[ABKPushStoryAppGroupKey] = @"YOUR-APP-GROUP-IDENTIFIER";
[Appboy startWithApiKey:@"YOUR-API-KEY"
inApplication:application
withLaunchOptions:launchOptions
withAppboyOptions:appboyOptions];
1
2
3
4
let appboyOptions: [AnyHashable: Any] = [
ABKPushStoryAppGroupKey : "YOUR-APP-GROUP-IDENTIFIER"
]
Appboy.start(withApiKey: "YOUR-API-KEY", in:application, withLaunchOptions:launchOptions, withAppboyOptions:appboyOptions)
Option 2: Info.plist
Alternatively, to configure Push Story App Group from your Info.plist
file, add a dictionary named Braze
to your Info.plist
file. Inside the Braze
dictionary, add a string-typed PushStoryAppGroup
subentry and set the value to your App Group identifier. Note that prior to Braze iOS SDK v4.0.2, the dictionary key Appboy
must be used in place of Braze
.