iOS Notification Extensions

Teak uses iOS Notification Extensions to

Display rich media such as images, video, and custom thumbnails in iOS push notifications
Track confirmed receipts of iOS push notifications
Track impressions of rich media content
Display action buttons on expanded iOS push notifications

We recommend all games integrate Teak’s iOS Notification Extensions for maximum functionality.

If you have Build Post-Processing enabled then the Teak SDK’s included Build Post-Processing scripts will add the Teak iOS Notification Extensions to your Xcode project and build automatically. You’re done and can stop reading this page :)

Teak uses PlayerSettings.iOS.appleDeveloperTeamID to get the Team ID for the extension.

If your build process changes this at a later time, you’ll need to change it for the extensions as well.

Manual Integration

If you are not using Teak’s Build Post-Processing scripts then you will need to manually add the Teak iOS Notification Extensions to your project. We recommend updating your own build scripts to manage this process.

This document assumes that you have a working Xcode project for a game with Teak.

Notification Service Extension

Go to: File New Target and choose Notification Service Extension

Name it TeakNotificationService

This will create a group in your Xcode project that looks like this:

Dependencies

Add these to the Link Binary with Libraries Build Phase of the extension

AdSupport.framework
AVFoundation.framework
CoreGraphics.framework
ImageIO.framework
CoreServices.framework
StoreKit.framework
SystemConfiguration.framework
UIKit.framework
UserNotifications.framework
libTeak.a

You can find libTeak.a in Libraries/Teak/Plugins/iOS in the Xcode project structure, and drag it into the 'Link Binary with Libraries' step.

Code

Change the code in TeakNotificationService/NotificationService.h to look like this:

TeakNotificationService/NotificationService.h

#import <UserNotifications/UserNotifications.h>

// This is the declaration of `TeakNotificationServiceCore`, the implementation
// is in 'libTeak.a'. It is done this way so you do not need to fight with
// include paths.
@interface TeakNotificationServiceCore : UNNotificationServiceExtension
- (void)serviceExtensionTimeWillExpire;
@end

@interface TeakNotificationService : TeakNotificationServiceCore
- (void)serviceExtensionTimeWillExpire;
@end

This declares TeakNotificationServiceCore and inherits from it, which will pull in the functionality from libTeak.a which will take care of everything else.

Change the code in TeakNotificationService/NotificationService.m to look like this:

TeakNotificationService/NotificationService.m

#import "NotificationService.h"

@implementation TeakNotificationService
- (void)serviceExtensionTimeWillExpire {
    [super serviceExtensionTimeWillExpire];
}
@end

PrivacyInfo.xcprivacy

The Teak SDK includes a PrivacyInfo.xcprivacy suitable for the notification service extension in Assets/Teak/Editor/iOS/TeakNotificationService/PrivacyInfo.xcprivacy. This file or a similar one should be added to the Copy Bundle Resources build phase of the TeakNotificationService target.

Notification Content Extension

Go to: File New Target and choose Notification Content Extension

Name it TeakNotificationContent

Delete the auto-generated NotificationViewController.storyboard from your project.

You should now have a group in your Xcode project that looks like this:

image::content-extension-group.png

Dependencies

Add these to the Link Binary with Libraries Build Phase of the extension

AdSupport.framework
AVFoundation.framework
CoreGraphics.framework
ImageIO.framework
CoreServices.framework
StoreKit.framework
SystemConfiguration.framework
UIKit.framework
UserNotifications.framework
UserNotificationsUI.framework
libTeak.a

image::content-extension-link.png

You can find libTeak.a in Libraries/Teak/Plugins/iOS in the Xcode project structure, and drag it into the 'Link Binary with Libraries' step.

Code

Change the code in TeakNotificationContent/NotificationViewController.h to look like this:

TeakNotificationContent/NotificationViewController.h

#import <UIKit/UIKit.h>

// This is the declaration of `TeakNotificationViewControllerCore`, the implementation
// is in 'libTeak.a'. It is done this way so you do not need to fight with
// include paths.
@interface TeakNotificationViewControllerCore : UIViewController
- (void)viewDidLoad;
@end

@interface TeakNotificationViewController : TeakNotificationViewControllerCore
- (void)viewDidLoad;
@end

Change the code in TeakNotificationContent/NotificationViewController.m to look like this:

TeakNotificationContent/NotificationViewController.m

#import "NotificationViewController.h"

@implementation TeakNotificationViewController
- (void)viewDidLoad {
    [super viewDidLoad];
}
@end

Plist

You can also download the latest copy of this PList here https://sdks.teakcdn.com/ios/Info.plist

Open TeakNotificationContent/Info.plist with a text editor and replace the contents with:

TeakNotificationContent/Info.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>CFBundleDevelopmentRegion</key>
    <string>$(DEVELOPMENT_LANGUAGE)</string>
    <key>CFBundleDisplayName</key>
    <string>TeakNotificationContent</string>
    <key>CFBundleExecutable</key>
    <string>$(EXECUTABLE_NAME)</string>
    <key>CFBundleIdentifier</key>
    <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
    <key>CFBundleInfoDictionaryVersion</key>
    <string>6.0</string>
    <key>CFBundleName</key>
    <string>$(PRODUCT_NAME)</string>
    <key>CFBundlePackageType</key>
    <string>XPC!</string>
    <key>CFBundleShortVersionString</key>
    <string>1.0</string>
    <key>CFBundleVersion</key>
    <string>1</string>
    <key>NSExtension</key>
    <dict>
        <key>NSExtensionAttributes</key>
        <dict>
            <key>UNNotificationExtensionCategory</key>
            <array>
                <string>TeakNotificationContent</string>
                <string>TeakNotificationPlayNow</string>
                <string>TeakNotificationClaimForFree</string>
                <string>TeakNotificationBox123</string>
                <string>TeakNotificationGetNow</string>
                <string>TeakNotificationBuyNow</string>
                <string>TeakNotificationInteractiveStop</string>
                <string>TeakNotificationLaughingEmoji</string>
                <string>TeakNotificationThumbsUpEmoji</string>
                <string>TeakNotificationPartyEmoji</string>
                <string>TeakNotificationSlotEmoji</string>
                <string>TeakNotification123</string>
                <string>TeakNotificationFreeGiftEmoji</string>
                <string>TeakNotificationYes</string>
                <string>TeakNotificationYesNo</string>
                <string>TeakNotificationAccept</string>
                <string>TeakNotificationOkay</string>
                <string>TeakNotificationYesPlease</string>
                <string>TeakNotificationClaimFreeBonus</string>
            </array>
            <key>UNNotificationExtensionDefaultContentHidden</key>
            <false/>
            <key>UNNotificationExtensionInitialContentSizeRatio</key>
            <real>0.01</real>
        </dict>
        <key>NSExtensionPointIdentifier</key>
        <string>com.apple.usernotifications.content-extension</string>
        <key>NSExtensionPrincipalClass</key>
        <string>TeakNotificationViewController</string>
    </dict>
</dict>
</plist>

PrivacyInfo.xcprivacy

The Teak SDK includes a PrivacyInfo.xcprivacy suitable for the notification service extension in Assets/Teak/Editor/iOS/TeakNotificationContent/PrivacyInfo.xcprivacy. This file or a similar one should be added to the Copy Bundle Resources build phase of the TeakNotificationContent target.

Testing

Set up an iOS notification with an expanded view using both a button and an animated GIF.

Make it a happy one, so you can celebrate. Here’s a classic https://media.giphy.com/media/d86kftzaeizO8/200.gif

Preview the notification, and send it to your test device. The preview should look like this:

The expanded view should look like this:

I see the GIF, but no buttons

Check to make sure that TeakNotificationViewController is being built properly, and that TeakNotificationContent/Info.plist contains the contents as specified above.

I see no small image preview

Make sure that TeakNotificationService is being built properly.

We use a Ruby script for automating this process during our testing. Feel free to use it for your own build process as well.

This zip file contains the script, and all needed code and dependencies: https://sdks.teakcdn.com/ios/TeakExtensions.zip

Emails from Apple

You may receive some confusing error/warning emails from Apple that are related to App Extensions.

:ref:`version_string_mistatch_email`
:ref:`keychain_access_email`