ForeSee Developer Portal

Everything you need to configure and optimize your ForeSee products. Home of developer documentation, implementation guides, and release notes.

Blueprint

Release Notes

ForeSee® iOS SDK

5.3.1 -- Swift 5

Released on May 14th, 2019:
documentation

New features

  • Added support for Swift 5

5.3.0 -- Modern survey

Released on April 25th, 2019:
documentation

New features

  • Modern Survey
    A modern look and feel for supported surveys; please ask your account manager if your survey is compatible, then add surveyStyle to your configuration to enable.

Improvements

  • Improved Feedback look and feel
  • Addressed compiler warnings in the ForeSee frameworks
  • Improved crash tracking

Fixes

  • Stability and performance fixes

5.2.1 -- Email-only invite

Released on February 28th, 2019:
documentation

New features

  • Email-only invitation mode.

Improvements

  • Adds foreign-language translations to SDK for new invitation styles.

Fixes

  • Fixes bug in state transition (automatically dismiss the survey and transition to "complete" when submitted without network).
  • Fixes bug where keyboard covers Submit button when entering a phone number in landscape.

5.2.0 -- Feedback

Released on Janurary 24th, 2019:
documentation

New features

  • Added Feedback surveys feature.
  • Support for iOS 12

Fixes

  • Fixed false errors when submitting contact details using a custom invitation

5.1.0 -- Modern invite

Released on August 2, 2018:
documentation

New features

  • New invitation designs. Do not upgrade without reviewing the Configuration file as styling options have changed!

Improvements

  • Added new strings and translations for English, German, Spanish, French, and Portuguese.
  • Introduced new methods for providing contact details with type information.
  • Modified CONTACT invitation flow (existing details are now pre-populated).
  • Better accessibility support (large fonts, specifically).
  • Support for modern notifications (UNNotificationResponse), and deprecated handling of legacy notifications (UILocalNotification).
  • Added a product_type CPP.

Fixes

  • Fixed bug where the top portion of survey is blocked by navbar on some devices.

Deprecations.

  • Dropped iOS 9 support.
  • Deprecated custom survey views.
  • Retired the Replay product. See Removing References to Replay

Removing References to Replay

With version 5.1+ of the Mobile SDK, we have retired the Replay product.
Please make sure to remove any references to these older Replay functions or you may experience build errors:
isRecording
logReplayPageChange:(NSString )pageName
maskView:(UIView
)view
unmaskView:(UIView )view
autoMaskViewsWithinView:(UIView
)view
maskAlertsForWebView:(UIWebView )webView
unmaskAlertsForWebView:(UIWebView
)webView
maskedViews
setMaskingDebugEnabled:(BOOL)enabled
isMaskingDebugEnabled

5.0.3

Released on April 16, 2018:

  • Mask alert controllers
  • Mask callout bars
  • Mask keyboards

5.0.2

Released on March 14, 2018:

  • Re-included Replay as ForeSeeReplay.framework (Note: this was later removed again with 5.1+).

5.0.1

Released on March 3, 2018:

  • Revert framework project dir to ForeSee.framework for backward compatibility.
  • Fix other name-casing inconsistencies.
  • Make UserNotifications a "weak" framework.
  • Properly enable bitcode for fat framework.
  • Fix bug preventing client logos from showing on invitations.

5.0.0

Released on February 19, 2018:

  • Removed calls to non-public APIs.
  • Removed Replay features (Replay features will be released as a separate SDK).
  • Ended support for iOS 8.

Older iOS SDK versions

We recommend using only iOS SDK versions 5.0.0 and above. Earlier versions of the SDK utilize private APIs which may result in App Store rejection.


4.3.2

Released on January 23, 2018:

  • Fixed survey layout issues on iPhone X.
  • Improved handling of live web masking.
  • Fixed issue where Replay wouldn't capture when app started in landscape.
  • Increased SDK stability.

4.3.1

Released on December 12, 2017:

  • Made method swizzling compatible with New Relic.
  • Fixed NSRangeException in Replay image creation.
  • Improved handling of missing contact details on custom CONTACT invitations.
  • Found and addressed memory leaks that could cause stability issues.

4.3.0

Released on November 6, 2017:

Improvements

  • iOS 11 support.
  • Allow multiple values for a single CPP.
  • Add screen reader/accessibility functionality.
  • Show a custom alert message for blacklisted URLs.
  • Turn off URL whitelisting for browser (privacy policy, etc.).
  • Update ForeSee logo.
  • Add “Local” and “Immediate” modes to notification type CPP.

Fixes

  • Fix issue where custom CPPs aren't passed to local notification surveys.
  • End sessions gracefully on crashes.
  • Fix issue where daysSinceLastLaunch will reset if you background and wake the app again.
  • Fix issue where status is set to Declined if you dismiss the ‘thank you’ page.
  • Fix issue where app freezes when replay is running and certain controllers are presented.
  • Fix issue where web view masks are misaligned on iOS 11.
  • Fix NSInvalidArgument exception when starting the app.
  • Prevent crashes during screen capture.
  • Fix placeholder text in CONTACT invitations

4.2.2

Released on June 15, 2017:

Fixes:

  • Validate failed events before deserializing.

4.2.1

Released on May 11, 2017:

Fixes:

  • Fix public TRMeasure interface.
  • Archived versions.

4.2

Released on May 10, 2017:

Improvements:

  • Add version to log messages.
  • Add metrics for tracking which criteria were met.
  • Switch to new eventing endpoints.
  • Simulcast CPP\'s to new eventing endpoint.
  • Add app version to CPPs.
  • Replace invite \"Privacy Policy\" link to \"Terms and Conditions\".
  • Add more eventing to troubleshoot collection.
  • Expose TRMeasure to the public.

Fixes:

  • Calling maskView could mark a view to be masked even if replay is disabled.
  • Fix auto-masking in table views.
  • State could transition to decline when ON_EXIT invite cannot be completed due to network failure.
  • Change \"addCPP\" to \"setCPP\".

4.1

Released on Feb 27, 2017:

Fixes:

  • iOS 10 support.
  • Drop support for iOS 7 and iOS 8 (we now support iOS 9 and above).
  • Page count should be reset whenever the app is launched.
  • Garbled replay on some large devices.
  • Crash during replay reported by some clients.
  • CPPs not removed when \"repeat days\" is met.
  • Update privacy policy link on invitations.
  • Remove use of deprecated methods.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.

4.0.0

Released on Jul 06, 2016:

Fixes:

  • Invite moves off screen when entering contact info.
  • Fix project README for CocoaDocs.

Improvements:

  • Rename ON_EXIT to CONTACT.
  • All new custom invitations.
  • Sample app with nice-looking custom invitation.
  • Create delegate for listening to SDK events.
  • Combine eligibility check with significant events.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4.6

Released on Apr 28, 2016:

Fixes:

  • Fix garbled replays on large-screen devices.

Improvements:

  • Now available via Cocoapods.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4.5

Released on Mar 25, 2016:

Fixes:

  • Match status bar style to parent window when showing invitation.
  • Fix custom invitation demo app.
  • Fix blank screen when showing survey WebViews

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
    *Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4.4

Released on Feb 11, 2016:

Fixes:

  • Last launch date should only be updated when the app is backgrounded or terminated.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4.3

Released on Nov 16, 2015:

Improvements:

  • Add locale CPP.
  • Persist CPPs across session.
  • Improve sample projects.

Fixes:

  • ON_EXIT invitation hidden behind keyboard.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4.2

Released on Oct 14, 2015:

Improvements:

  • Create Swift sample app.

Fixes:

  • App can crash when synchronizing failed log events.
  • Crash when loading webView for survey after network error.
  • Prevent use of DEBUG URLs in client builds.
  • Fix image references in sample apps.
  • Create missing kb docs folder in build script.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4.1

Released on Sep 21, 2015:

Improvements:

  • Support iOS 9.
  • Add foreign language surveys to localization sample app.
  • Add method to disable event logging.
  • Improve the ForeSee.h public interface.
  • Make TRUSTe logo on invitation a clickable link to the ForeSee TRUSTe page.
  • Update the sample apps.

Fixes:

  • Live masks appear behind prompts and keyboard (when prompt is showing).
  • Survey does not render correctly in landscape on some iOS versions.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.4

Released on Aug 10, 2015:

Improvements:

  • Specify config file programmatically.
  • Add ability to combine Trigger criteria.
  • Add a new Trigger parameter - days since last launch.
  • Rename daysSinceLaunch to daysSinceFirstLaunch for consistency.
  • Allow storage limit to be adjusted via configuration file.
  • Commit criteria counts to storage as soon as they are changed.
  • Add improved logging.
  • Create privacy policy link on survey invitation.
  • Add locale CPP.
  • Add criteria in configuration file for cell data usage.
  • Prevent caching of blacklist check data.
  • Improve resilience against uncalled start methods.
  • Select when push notifications are enabled in config.
  • Add View Controller loads to config criteria.
  • Add free space ratio check.
  • Mask debugging.

Fixes:

  • Keyboard mask is misplaced on Replay.
  • Masking of text on WebView autocorrect is misplaced.
  • Autocorrected words masked in WebViews.
  • Pages can get stuck in Replay
  • App may crash when showing keyboard in ON_EXIT mode.
  • Invalid touches sent for iOS 8.
  • App can freeze when rotating with keyboard on screen in test app.
  • Replay doesn't work correctly when app started in landscape.
  • App can erroneously end sessions for insufficient space.
  • Rotating the screen with the keyboard up for the OnExit email entry dialog can freeze the app on some devices.
  • Fix for iOS 7 backwards compatibility.
  • Default SDK start (with default config) can crash.
  • Create build with dysm information for Veracode scan to improve security.
  • App crashes if survey is shown when device storage is full.
  • Invite Accepted and Invite Declined events are not sent in Local and OnExit modes.
  • Improve SDK tests.
  • Blacklist check should fail when JSON is badly formatted.
  • Front window skipped when scrolling WebView.
  • Text masked in unmasked fields when auto-correct is shown.
  • Survey being covered by mask in backing WebView.
  • Sessions missing on iOS 8.
  • Sessions end unexpectedly in iOS 8.
  • Replays can crash on long sessions.
  • WebViews should be unmasked by default.
  • Handle counter reset in initialization.

Remaining Limitations:

  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.3.5

Released on Jul 30, 2015:

Fixes:

  • User is no longer moved into a declined state whenever pooling check doesn't pass.
  • Crash in some use cases on iOS 7.

Remaining Limitations:

  • Storage use is based on absolute values and doesn’t take into account the percentage of free space.
  • The config file must be contained within the app package as foresee_configuration.json. This means dynamic configuration is not available for anything but CPPs.
  • Long sessions are possible if iOS 4.3 device is left to idle. These sessions will contain long empty periods and therefore not take up extra space on the device. 4.x is no longer officially supported.
  • Custom survey views do not update the trigger state when completed.
    Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.3.4

Released on Jun 25, 2015:

Improvements:

  • Security updates to meet HIPPA requirements.
  • Added logging to track flow through invite/survey funnel.

Fixes:

  • Rename JSONString on NSDictionary to avoid conflicts with Cordova.
  • Autocorrect text partially rendered in Replay.
  • Crashlytics for 3.3.4 SessionReplayApp.
  • Cannot fully accept OnExit invitation.
  • Fix security hole in iOS (pooling check).
  • Cannot see text field of email entry field when in landscape mode.
  • Crash on iOS 6 when using WebView delegates.

Remaining Limitations:

  • Storage use is based on absolute values and doesn’t take into account the percentage of free space.
  • The config file must be contained within the app package as foresee_configuration.json. This means dynamic configuration is not available for anything but CPPs.
  • Long sessions are possible if iOS 4.3 device is left to idle. These sessions will contain long empty periods and therefore not take up extra space on the device. 4.x is no longer officially supported.
  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.3.1

Released on Oct 02, 2014:

Improvements:

  • Added backwards compatibility with XCode 5.

Fixes:

  • XCode 5 compatibility issues.

Remaining Limitations:

  • Storage use is based on absolute values and doesn’t take into account the percentage of free space.
  • The config file must be contained within the app package as foresee_configuration.json. This means dynamic configuration is not available for anything but CPPs.
  • Long sessions are possible if iOS 4.3 device is left to idle. These sessions will contain long empty periods and therefore not take up extra space on the device. 4.x is no longer officially supported.
  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is
    displayed.
  • Invitations display poorly in some replays. This does not affect the user’s perception of the invitation and only happens on apps deployed using XCode 5 which are running on an iOS 8 device.

3.3.0

Released on Sep 25, 2014:

Improvements:

  • Added iOS 8 compatibility.
  • Allowed capture of WebViews during loading.

Fixes:

  • Camera view is not masked in iOS 8.
  • Masked alert views are not masked in iOS 8.
  • Orientation changes ignored in iOS 8.
  • Survey appears garbled in iOS 8.
  • Misplaced invitation in iOS 8.
  • Local notifications don\\'t work in iOS 8.
  • Infinite loop on show invite in rare situations.
  • Crash on state dealloc due to KVO.
  • Some masked items appearing in Replays.
  • Thin white line on survey view.
  • Survey layout incorrect in iOS 8.
  • Web video crashes Replay.
  • Crash coming back into app.

Remaining Limitations:

  • Storage use is based on absolute values and doesn’t take into account the percentage of free space.
  • The config file must be contained within the app package as foresee_configuration.json. This means dynamic configuration is not available for anything but CPPs.
  • Long sessions are possible if iOS 4.3 device is left to idle. These sessions will contain long empty periods and therefore not take up extra space on the device. 4.x is no longer officially supported.
  • Custom survey views do not update the trigger state when completed.
  • Customized backgrounded app previews (in the task switcher) are interrupted if an invitation is displayed.

3.2.0

Released on Jun 23, 2014:

  • Added automatic masking of address book and email composition pages.
  • Added continuous testing of storage use - sessions can be partial.
  • Removed deprecated functions.
  • Increased efficiency by removing dependency on temporary graphics context.
  • Increased time resolution of gesture tracking.
  • Restricted initialization of replay module to implementations that use Replay.
  • Improved title fetching on automatically logged page changes.

Release Notes


ForeSee® iOS SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.