DASH

Purpose

This library provides an easy way to embed the DASH mobile experience into an iOS application. For more information check out DASH

Installation

The easiest way to use DASHEmbed: Cocoapods

pod 'DASHEmbed'

Manual Install: Static Framework

• Download zip with pre-built 2.0.0 framework assets here. This framework was built with Base SDK of iOS 12.0 in Xcode 11.2.1, Objective-C, and Bitcode enabled. Requires iOS 10+. If you need more customization (different version of Xcode, bitcode disabled), you can build the framework yourself below. Other downloads can be found on the Releases page.

OR

• Build the static framework using the "DASHEmbed-Aggregate" target. (Builds to root of repository)
• Build the resource bundle using the "DASHResources" target. (Builds to products)

THEN

• Copy both DASHEmbed.framework and DASHEmbed.resources into your project (but don't add it to any targets).
• Add DASHEmbed.framework to the "Embedded Binaries" list of the target you wish to use with DASHEmbed. This should automatically add it to the "Linked Frameworks and Libaries" list.
• Add DASHEmbed.resources to the target you with to use with DASHEmbed.
• As DASHEmbed is written in Swift, be sure you include the Swift standard libraries if you aren't already. (You'll know if you encounter a runtime error regarding swift libraries when trying to use DASHEmbed). Simply set "Always Embed Swift Standard Libraries" to "YES" in your target's build settings. This will include everything needed. Be sure to clean between builds when changing these project settings as they don't always update until the next full build.

NOTE

• DASHEmbed.framework has a fat binary containing bitcode and the slices for the following architectures - (x86_64 i386 armv7 armv7s arm64). This allows for the framework to run on all devices and simulators, but will not be accepted to the App Store in it's current state. To remove the unneeded architectures for submission check out this article. He includes a build script you can add as a build phase which will remove all architectures except for the active ones in your bundled frameworks.

Manual Install: Source

1. Copy everything under "DASHEmbed/Framework" into your project.

Usage

Requirements

(2.0.0) iOS 12+, rewritten in Objective-C for greater compatibility across platform

(1.2.0) iOS 12+, Swift 5.0

(1.0.0 - 1.1.0) iOS 11+, Swift 4.0

User location is used for future location based features.

To enable, set a description for the NSLocationWhenInUseUsageDescription plist key.

To enable push notification functionality

We will need a 1) Push notification Encryption Key (.p8), 2) Key ID, 3) Developer Team Id, and 4) App bundle identifier from the Apple Developer Portal. For information on obtaining these assets see the "Obtain an Encryption Key and Key ID from Apple" section on Establishing a Token-Based Connection to APNs

Please note that the DASH framework and associated notifications do not affect badge counts.

After receiving the push assets above, we will provide you with an App ID to use in the app.

Create a DASHConfig

Create a DASHConfig. This is used to initialize the DASH library with needed information.

let appId = "APP_ID"
let dashConfig = DASHConfig(appId: appId)

A second initializer allow you to use the DASH development servers to test.

let dashConfig: DASHConfig
#if DEBUG
dashConfig = DASHConfig(appId: appId, useDevelopmentServers: true)
#else
dashConfig = DASHConfig(appId: appId)
#endif

Initialize the DASH library

Initialize library using the singleton.

DASH.team.start(with: dashConfig)

Set the push token to enable outbid notifications

//Sets the user's push token for outbid notifications
DASH.team.setUserPushToken(with: deviceToken)

Handling push notifications

func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
    //Check if DASH can handle the notification
    if DASH.team.canHandleNotification(response.notification) {
        DASH.team.setNotificationData(from: response.notification)
        //Trigger the display of the DASHViewController in your app
    }

    //Else, Handle other notifications

    completionHandler()
}

Set the user's email to enable autofill of email. DASH also determines if this user already has a DASH account

let email = "test@email.com"
DASH.team.setUserEmail(email)

Display the provided DASHViewController

guard let dashViewController = DASH.team.dashViewController() else { return }
dashViewController.delegate = self //Optionally set delegate

//Add a close button
let closeButton = UIBarButtonItem(title: "Close", style: .plain, target: self, action: #selector(closeDASHModal))
dashViewController.navigationItem.leftBarButtonItem = closeButton

Display modally

//Present
let navigationController = UINavigationController(rootViewController: dashViewController)
present(navigationController, animated: true, completion: nil)

Or push on a navigation stack

navigationController?.pushViewController(dashViewController, animated: true)

Check out the Current Documentation