Customizing iOS SDK

Broken link
iOS Manual Configuration
​Background modes​
​Notification alert in foreground​
​Controlling Log Level​
​Deep linking​
​In-Apps Tracking​
​Geozones push notifications​
​Creating a Rich Media queue​
​Custom UNNotificationCenterDelegate​
Background modes
To ensure that Pushwoosh SDK always receives the push token it is highly recommended to enable the Remote notifications option from the Background modes section of the Capabilities tab in your Xcode project. You can also enable this support by including the UIBackgroundModes key with the remote-notification value in your app’s Info.plist file.
Notification alert in foreground
By default Pushwoosh iOS SDK displays the notification banner when the app is running in the foreground.
You can control this behavior by setting the following boolean flag in your code (i.e. in your AppDelegate):
1
[PushNotificationManager pushManager].showPushnotificationAlert = 0; //set 0 to disable foreground notications, 1 to enable it 
Copied!
Controlling Log Level
To assist with debugging and integration, SDK will print all requests to the console by default. When you are ready for the production build, set "Pushwoosh_LOG_LEVEL" string key in your Info.plist file to one of the following values, depending on how much you want to see:
NONE - No logs from SDK
ERROR - Only display errors in console
WARNING - Also display warnings
INFO - Add informational messages
DEBUG - Add debug information
VERBOSE - Everything SDK can print and more
Deep linking
In your Info.plist file add URL types array with URL Identifier and URL Scheme.
In the example below the URL Scheme is com.pushwoosh and the URL Identifier is promotion.
In your App Delegate file (usually AppDelegate.m) add openURL delegate function as outlined in the example below. The example checks for the correct page, parses "id" value from the URL and opens PromoPageViewController in response.
Swift
Objective-C
1
func open(_ url: URL, options: [String : Any] = [:], completionHandler completion: ((Bool) -> Swift.Void)? = nil) {
2
        let components = URLComponents(url: url, resolvingAgainstBaseURL: false)
3
        let page = components?.host
4
        var promotionId: String?
5
        
6
        if page == "promotion" {
7
            return
8
        }
9
        
10
        let items = components?.queryItems ?? []
11
        
12
        for item in items {
13
            if item.name == "id" {
14
                promotionId = item.value
15
            }
16
        }
17
        
18
        //show PromoPageViewController
19
    }
Copied!
1
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
2
    NSURLComponents *components = [NSURLComponents componentsWithURL:url resolvingAgainstBaseURL:NO];
3
    NSString *page = components.host;
4
    NSString *promotionId = nil;
5
  
6
    //return if this is not a promotion deep link
7
    if(![page isEqualToString:@"promotion"])
8
        return NO;
9
​
10
    for(NSURLQueryItem *item in components.queryItems)
11
    {
12
        if([item.name isEqualToString:@"id"])
13
            promotionId = item.value;
14
    }
15
  
16
    PromoPageViewController *vc = [[PromoPageViewController alloc] init];
17
    vc.promotionId = promotionId
18
    [self presentViewController:vc animated:YES completion:nil];
19
}
Copied!
In-Apps Tracking
In paymentQueue:updatedTransactions: delegate method call sendSKPaymentTransactions method of PushManager
Swift
Objective-C
1
func paymentQueue(_ queue: SKPaymentQueue, updatedTransactions transactions: [SKPaymentTransaction]) {
2
        PushNotificationManager.push().sendSKPaymentTransactions(transactions)
3
        
4
        //the rest of the code, consume transactions, etc
5
    }
Copied!
1
- (void)paymentQueue:(SKPaymentQueue *)queue updatedTransactions:(NSArray *)transactions {
2
  
3
  [[PushNotificationManager pushManager] sendSKPaymentTransactions:transactions];
4
  
5
  //the rest of the code, consume transactions, etc
6
}
Copied!
Geozones push notifications
Gezones push notifications are encapsulated into a separate framework PushwooshGeozones.
1. To add PushwooshGeozones.framework to your project using a dependency manager, put the following lines in your podfile or cartfile:
Podfile
Carfile
target 'MyApp' do pod 'Pushwoosh/Geozones' end
github "Pushwoosh/pushwoosh-ios-sdk"
Also, you can simply drag and drop the framework into Link Binaries With Libraries in your project's Build Phases.
2. Add the following keys to your Info.plist:
NSLocationWhenInUseUsageDescription – (required) for app to track Geozones only while running in the foreground.
NSLocationAlwaysAndWhenInUseUsageDescription - (required) for app to track Geozones in both conditions and to show a permission request dialog pop-up.
NSLocationAlwaysUsageDescription – (optional) for app to track Geozones at all times; should be used if your app targets iOS 10 and earlier versions.
3. Import the framework:
Swift
Objective-C
1
import PushwooshGeozones
Copied!
1
#import <PushwooshGeozones/PWGeozonesManager.h>
Copied!
4. Start Geozones tracking when needed:
Swift
Objective-C
1
PWGeozonesManager.shared()?.startLocationTracking()
Copied!
1
[[PWGeozonesManager sharedManager] startLocationTracking];
Copied!
Creating a Rich Media queue
In case there are several Rich Media pages to display simultaneously (for example, trigger events for two or more In-Apps take place at one moment, or a Rich Media page is being displayed already at the moment a different trigger event occurs), you can set up a queue for Rich Media pages displaying. To create a queue, follow the steps described below.
1.
Create a class which implements PWRichMediaPresentingDelegate:
1
@interface ChainedRichMediaPresentingDelegate () <PWRichMediaPresentingDelegate>
2
​
3
@property (nonatomic) NSMutableArray *queue;
4
​
5
@property (nonatomic) BOOL inAppIsPresenting;
6
​
7
@end
8
​
9
​
10
@implementation ChainedRichMediaPresentingDelegate
11
​
12
- (instancetype)init {
13
    self = [super init];
14
    
15
    if (self) {
16
        _queue = [NSMutableArray new];
17
    }
18
    
19
    return self;
20
}
21
​
22
- (BOOL)richMediaManager:(PWRichMediaManager *)richMediaManager shouldPresentRichMedia:(PWRichMedia *)richMedia {
23
    [_queue addObject:richMedia];
24
    return !_inAppIsPresenting;
25
}
26
​
27
- (void)richMediaManager:(PWRichMediaManager *)richMediaManager didPresentRichMedia:(PWRichMedia *)richMedia {
28
    _inAppIsPresenting = YES;
29
}
30
​
31
- (void)richMediaManager:(PWRichMediaManager *)richMediaManager didCloseRichMedia:(PWRichMedia *)richMedia {
32
    _inAppIsPresenting = NO;
33
    
34
    [_queue removeObject:richMedia];
35
    
36
    if (_queue.count) {
37
        [[PWRichMediaManager sharedManager] presentRichMedia:_queue.firstObject];
38
    }
39
}
40
​
41
- (void)richMediaManager:(PWRichMediaManager *)richMediaManager presentingDidFailForRichMedia:(PWRichMedia *)richMedia withError:(NSError *)error {
42
    [self richMediaManager:richMediaManager didCloseRichMedia:richMedia];
43
}
44
​
45
@end
Copied!
2. Set the delegate:
1
 [PWRichMediaManager sharedManager].delegate = [ChainedRichMediaPresentingDelegate new];
Copied!
Custom UNNotificationCenterDelegate
If you want to use your own UNNotificationCenterDelegate (for example, for local notifications), you should inform Pushwoosh SDK about it for proper behavior. You can do it with the notificationCenterDelegateProxy property of Pushwoosh instance:
Swift
Objective-C
1
Pushwoosh.sharedInstance()?.notificationCenterDelegateProxy.add(my_delegate)
Copied!
1
[Pushwoosh.sharedInstance.notificationCenterDelegateProxy addNotificationCenterDelegate:my_delegate];
Copied!
Then, implement UNNotificationCenterDelegate methods in your delegate:
Swift
Objective-C
1
func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
2
    if (!PWMessage.isPushwooshMessage(notification.request.content.userInfo)) {
3
        // handle your notification
4
        completionHandler(UNNotificationPresentationOptions.alert)
5
    }
6
}
7
​
8
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
9
    if (!PWMessage.isPushwooshMessage(response.notification.request.content.userInfo)) {
10
        // handle your notification
11
        completionHandler()
12
    }
13
}
Copied!
1
- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler {
2
    if (![PWMessage isPushwooshMessage:notification.request.content.userInfo]) {
3
        //handle your message
4
        completionHandler(UNNotificationPresentationOptionAlert);
5
    }
6
}
7
​
8
- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler {
9
    if (![PWMessage isPushwooshMessage:response.notification.request.content.userInfo]) {
10
        //handle your message
11
        completionHandler();
12
    }
13
}
Copied!

iOS Message Delivery Tracking

VoIP Pushes

Last modified 1yr ago

Copy link

Contents

Background modes

Notification alert in foreground

Controlling Log Level

Deep linking

In-Apps Tracking

Geozones push notifications

Creating a Rich Media queue

Custom UNNotificationCenterDelegate