Campaign SDK for iOS

You can configure mobile app messages in iOS apps that are developed with Swift and Objective C.

The mobile app messaging SDK for Apple iOS provides support for the following:

• Registration for Apple Push Notification Service(APNS).
• Mobile app message handling and display.
• Support for inbox and in-app message.
• Support for SDK basic/custom events.
• Support for location-based messaging.

Get started

• Join the iOS Developer Program. Find your team that manages the Apple Developer Program for your organization.
• Subscribe to an Acoustic Campaign account. For more information, contact your customer service focal. To get started with Acoustic Mobile campaign, see Get started with mobile campaign.
• Install the iOS development tools.
• Install your developer certificate downloaded from your team’s Apple Developer page.

Download the iOS SDK

Download the latest version of the iOS SDK and access the iOS Native APIs references and plug-ins.

📘

Note:

SDK versions before v3.6.1.0 do not support Swift application delegates. As a workaround, you can use an Objective-C delegate class. For an example, see the sample Swift project provided in the mobile app messaging SDK v3.6.1.0 (and later).

Enable Automatic Reference Counting (ARC)

You must have an app that is compliant with Automatic Reference Counting (ARC). To enable ARC in your Xcode project,

• For Swift – go to Target > Build Phases > Compile Source. Then, select the files in the Plug-ins folder, and add -fobjc-arc.
• For Objective C – go to Edit > Convert > To Objective-C ARC and select the project you want to convert.

It is possible to use a non-ARC project as long as the SDK, its plug-ins, and templates are built with ARC turned on. To do so, go to Target > Build Phases > Compile Source, select the MCE files, and add -fobjc-arc to all of them.

Migrate to the latest version of Swift

To migrate to the latest version, click Edit Menu > Migrate > Current Swift Syntax.

import Foundation
import UIKit
import AcousticMobilePush
let _ = UIApplicationMain(CommandLine.argc, CommandLine.unsafeArgv, nil, NSStringFromClass(MCEAppDelegate.self) )

import Foundation
import UIKit 
import AcousticMobilePush
let argv = UnsafeMutableRawPointer(CommandLine.unsafeArgv).bindMemory(to: UnsafeMutablePointer.self, capacity: Int(CommandLine.argc))
let _ = UIApplicationMain(CommandLine.argc, argv, nil, NSStringFromClass(MCEAppDelegate.self) )

Understand the iOS payload formats

A payload is a property list that specifies how alerts and custom data are displayed to your app user. A JSON dictionary object defines the property list.

Here is an example of a very simple APNS payload that sets the app badge to 2 and opens a URL when clicked:

{
    "aps": {
        "alert": "Bob wants to play poker",
        "badge": 2
    },
    "notification-action": {
        "type": "url",
        "value": "https://acoustic.com"
    }
}

Advanced payload options

Advanced message options are available on iOS 10 (and later). These options require more information in the payload.

You can use Notification Content Extensions to add media attachments to push notifications.
To add media attachments:

1. Add the mutable-content flag to the aps key in the iOS 10 payload.
2. Then, add the media-attachment key to the root of the iOS 10 payload.

The URL for the media file is specified in the media-attachment key of the payload. The notification service downloads the media file from the URL in the payload. The media file is then attached to the message.

There are several keys that you can use in the iOS payload.

Best practice for specifying file sizes in media attachments

When you add media attachments to messages in iOS 10 apps, follow Apple's size limits:

• Audio Types: wav, aiff, mp3 or m4a Max Size: 5MB
• Image Types: gif, jpg, png Max Size: 10MB
• Video types: mp4, mpg, avi Codec: MPEG, MPEG2, MPEG4, AVI Max Size: 50MB
  For more details about Apple's supported file types for media, see UNNotificationAttachment.

The following code example shows a more complicated iOS payload:

{
    "aps": {
        "mutable-content": 1,
        "alert": {
            "title": "Notification title",
            "subtitle": "Notification subtitle",
            "body": "Notification body"
        }
    },
    "media-attachment": "https://url/to/content.mpg",
    "notification-action": {
        "type": "url",
        "value": "http://acoustic.com"
    },
    "category-actions": [
        {
            "name": "foo",
            "type": "url",
            "value": "https://acoustic.com"
        },
        {
            "name": "bar",
            "type": "url",
            "value": "https://example.com"
        }
    ],
    "category-name": "content-extension"
}