GuidesTech Track Webinars

Getting Started (Installation & Configuration)

Requirements

  • Minimum Deployment Target of iOS 9.0 (the SDK is disabled on iOS 10 and below)
  • Xcode 12

1. Installation

Installing with CocoaPods

  1. Add the following to your Podfile:
platform :ios, '14.0'  

pod 'ForeSee'
pod 'ForeSee/ForeSeeFeedback' # optional for Feedback

Information about the latest ForeSee SDK CocoaPod can be found its CocoaPods page.

Visit the CocoaPods website for help getting started with Podfiles.

🚧

Alpha Releases

The CocoaPods website always shows the latest version of a pod, even if it's a pre-release version (e.g. 6.0.0-alpha1). CocoaPods is sophisticated enough to properly handle pre-release pods in the Podfile, but the website makes no distinction between pre-release and production-ready versions. Pre-release pods are not suitable for App Store submissions.

Manual Installation

If your project does not use CocoaPods, you must install the SDK manually. You can download the latest version from the following page: ForeSee iOS SDK Release Notes.

You'll then need to add each of the XCFrameworks to your poject

  1. Copy each of the included ./lib/*.xcframework files into your project.

  2. Add the frameworks to your project (Your Target -> General -> Frameworks, Libraries, and Embedded Content). The frameworks must be embedded (Embed & Sign or Embed Without Signing)

🚧

Older versions of Xcode

The previous step is split into two steps in previous versions of Xcode (before Xcode 11):

2a. Include the frameworks as embedded binaries (Your Target -> General -> Embedded Binaries).

2b. Find the folder that contains the ForeSee framework files and add that folder to the target's Framework Search Paths (Your Target -> Build Settings -> Search Paths -> Framework Search Paths)

Additional steps for older versions of the SDK

Some older versions of the SDK (pre-framework) require additional setup steps.

🚧

The following steps are usually not required. These steps are presented for older versions of the ForeSee SDK (before 5.0.0).

  1. Add the images in the assets folder to your project. Please be sure to add the images as individual (or group of) files and not via the folder containing the images, as this causes problems in certain scenarios.

  2. Add the following frameworks to your project (Build Phases -> Link Binary With Libraries):

    • AVFoundation
    • CoreGraphics
    • CoreMedia
    • CoreMotion
    • CoreVideo
    • QuartzCore
    • SystemConfiguration
    • libz
    • UserNotifications
    • Foundation

  3. Add -ObjC to the OTHER_LDFLAGS setting of your project.

Uploading your app to the App Store

🚧

The following steps are usually not required. These steps are presented for older versions of the ForeSee SDK (before 6.0.4).

Older versions of the ForeSee iOS SDK are distributed using fat binaries containing both device and simulator architectures:

$ lipo -info lib/ForeSee.framework/ForeSee
Architectures in the fat file: lib/ForeSee.framework/ForeSee are: armv7 armv7s x86_64 i386 arm64

For manual installation you'll need to remove the simulator slices before uploading your app. More information can be found in the Common Problems section.

2. Configuration

After installation, follow these instructions to create your foresee_configuration.json file and add it to your project. Here's a minimal sample configuration to get you started:

{
    "clientId":"9NNs9GIBQIVdk1LpDlJpAQ==",
    "measures":
    [
        {
            "surveyId": "mobile_app-en",
            "launchCount": 0
        }
    ]
}

❗️

This is not a complete config. Be sure to replace the clientId in the above config with your own client ID before releasing your app. Your actual configuration will likely contain additional fields. Follow these instructions to create your foresee_configuration.json.

🚧

Configuration Tip

Some configuration options are required for proper function of the SDK. Remember to verify that important configuration items (e.g. appName and logo) are defined correctly in the foresee_configuration.json file.

3. Instrumentation

Continue to the implementation instructions for either Objective-C or Swift.

Updated over 1 year ago