iOS SDK Release Notes

# 12.2.0

Released 2023-12-04

IMPORTANT: Users must add the following line to their PodFile to compile the SDK:

pod 'Down'

# Changes

• Added Markdown with rich text support

# 12.0.0

Released 2023-09-14

NOTE: With this release, we’ve dropped support for iOS 13 and now only support iOS 14.0 and up.

# Changes

• IMPORTANT: Drop support for iOS 13
• Fix - More button color now updates properly

# Interface changes

None

# 11.1.4

Released 2023-05-24

# Changes

• Fix confirmation action sheet disappearing after resuming
• Change wording to “Chat disconnected” when trying to reconnect

# Interface changes

None

# 11.1.3

Released 2023-02-24

# Changes

• Fix text field scrolling behind keyboard after focusing

# Interface changes

None

# 11.1.2

Released 2023-01-03

# Changes

• Add mask validation for component views
• Fix re-registering for push notifications
• Fix response not being announced after quick reply is selected
• Fix chatViewControllerDidDisappear not getting called
• Fix Scale view stars disappearing when decrementing from minimum
• Fix navigation styles not being applied

# Interface changes

None

# 11.1.1

Released 2022-12-14

# Changes

• Button in loading state doesn’t match design spec
• Speculatively prevent crash in MetricsPersistenceManager

# Interface changes

None

# 11.1.0

Released 2022-12-09

# Changes

• Add gesture to swipe from left edge
• Update unread messages indicator while getting new messages when app is resumed
• Fix unsent text reappearing after chat input is hidden
• Prevent user from sending message containing only whitespace
• Crash early with proper error message when the SDK is not correctly initialized
• Add background color of selected state to .onBackground at 0.05 alpha
• Update New Question button font size
• Change bodyBold2 to 15 pt
• Hide input when showing chat
• Fix date picker
• Remove websocket connection check before handling links
• Fix More button color after toggling isDarkModeAllowed
• Handle errors when the user leaves the waiting queue
• Allow user to tap empty space below message to show quick replies with input
• Reverse EWT progress bar direction
• Fix missing back button for second component view
• Fix submit button going out of bounds issue
• Clear error from component if validated
• Enable re-registration of device token for expired anonymous sessions
• Remove unread message view hidden status when not live
• Keep attachment icon visible when user starts typing
• Fix textfields hidden by Submit button issue
• Set the light mode/dark mode appearence for the alert controller
• Fix carousel scrolling bug
• Show “99+” if there are more than 99 unread messages
• Set input field height to 3.5 times the line-height
• Make action sheet and gatekeeper buttons follow CUI styles
• Improve Scale View accessibility
• Ensure addition and removal of on-screen components are properly exposed to assistive technology
• Add accessibility headings to header CUI labels
• Ensure hidden, decorative and duplicate content and artifact elements are not exposed to assistive technologies
• Ensure focus is logically set when a module opens and when pop-up alerts close
• Fix showing New Question on start
• Handle localization & language matching, add es support
• Change restart button font size to 15 pt
• Fix nav bar color when scrolling to top while dark mode is disallowed
• Prevent radio buttons from being unselected
• Fix text area getting cut off when expanding below accessory view
• Fix submit button repositioning bug
• Fix SDK button consistency issues
• Set correct highlighted state for buttons
• Set confirmation and fullscreen title to header2
• Fix quick replies not working error
• Fix untranslated “wait” string
• Fix translation of inline error message for required fields
• Omit language header if no supported languages are set
• End editing when the user taps button view in component view

# Interface changes

None

# 11.0.0

Released 2022-04-15

# Highlights

We’ve removed support for iOS 12 and now only support iOS 13.0 and up.

# Changes

• Improve color contrast of chat input placeholder text
• Fix bug involving anonymous sessions and push notification registration
• Allow showing timestamps for multiple messages at once

# Interface Changes

• Removed deprecated properties ASAPP.authTokenKey and .analyticsKey.

# 10.4.1

Released 2021-10-27

# Changes

Miscellaneous bug fixes.

# Interface Changes

None

# 10.4.0

Released 2021-10-08

# Changes

Miscellaneous bug fixes and performance improvements.

# Interface Changes

None

# 10.3.0

Released 2021-06-21

# Changes

• Add Objective-C support for camera and photo library authorization request properties
• Fix format of attached image URL

# Interface changes

• Added ASAPP.objcShouldRequestCameraAuthorization and .objcShouldRequestPhotoLibraryAuthorization only for Objective-C compatibility.

# 10.2.0

Released 2021-05-06

# Highlights

We’ve introduced a custom UI to prompt the user to give your app the permission to send push notifications. We’ve also begun detecting whether the user is on a call with support and blocking chat while the call is in progress.

# Changes

• Add custom UI for requesting permission to send push notifications
• Block chat while call is in progress
• Fix input state bugs
• Fix bug that led to missing messages

# Interface changes

• Changed the default value of ASAPP.shouldRequestNotificationAuthorization from false to true.
• Added ASAPPStrings.callInProgressBody.

# 10.1.0

Released 2021-02-02

# Highlights

Adds support for ASAPP’s Estimated Wait Time functionality.

# Changes

• UI affordances and feature enchancements for Estimated Wait Time (EWT)
• Include out-of-total in VoiceOver description for Scale component
• Update Scale component colors and icons
• Remove search field accessibility trait from chat input
• Fix chat input while in inQueue state
• Fix shimmer animation not adapting to Dark Mode
• Show upload options from main thread

# Interface changes

None

# 10.0.0

Released 2020-12-01

# Highlights

• We’ve removed support for iOS 11 and now only support iOS 12.0 and up.
• The SDK is now built with Xcode 12.
• We now provide the SDK only as an .xcframework.

# Changes

• Drop support for iOS 11
• Build framework with Xcode 12
• Stop providing .framework
• Fix inline form state change crash
• Fix persistent pasteboard notification bug

# Interface Changes

• Changed chatViewControlledDidTapDeepLink(name:data:) to chatViewControllerDidTapDeepLink(name:data:) in the ASAPPDelegate protocol (specifically, we fixed the typo).

# 9.4.0

Released 2020-09-10

# Highlights

We’ve introduced the Chat Instead feature to the SDK, which lets you display an action sheet menu listing various configurable customer support channels, such as ASAPP chat, in addition to a phone number.

# Changes

• Deprecate authTokenKey and analyticsKey
• Implement Chat Instead feature
• Prevent jumpiness in messages view by fixing update logic
• Fix focusing on a form input while keeping the submit button visible as the keyboard animates
• Fix scroll view height being adjusted incorrectly
• Move text area border view behind text view
• Show New Question button if empty state has stuck around for too long
• Improve action sheet state management
• Fix anonymous users losing their session when reconnecting
• Fix modal adjusting frame for keyboard that isn’t there

# Interface Changes

• Deprecated ASAPP.authTokenKey and .analyticsKey.
• Added ASAPPChatInsteadViewController.
• Added ASAPPChannelDelegate.
• Added ASAPPChannel.
• Added ASAPPError.openChannelFailed.
• Added ASAPPStrings.accessibilityCloseChatInstead.
• Added ASAPP.createChatViewControllerForPresentingFromChatInstead() and .createChatViewControllerForPushingFromChatInstead(). Use these methods only when opening chat from the Chat Instead menu.

# 9.3.0

Released 2020-06-22

# Highlights

In addition to a dynamic framework, we now offer the ASAPP iOS SDK as a static framework.

Please note that using the static framework will require you to include the provided ASAPPResources bundle in your target’s Copy Bundle Resources build phase.

Whether you use the static or dynamic flavor of our iOS SDK, we recommend you use the .xcframework compiled with bitcode.

# Changes

• Remove overview from docs readme/index page
• Fix long-press hit test to allow copying of messages
• Automatically find resources bundle by URL
• Fix misleading error message when loading resource bundle
• Remove DispatchTimeInterval extension from public interface
• Fix text inputs being obscured by keyboard
• Fix visual bouncing when selecting text inputs
• Fix autosuggest re-rendering bug
• Add file signature
• Fix scrolling when presenting ComponentViewController
• Prevent render loop when image fails to load
• Fix messages sent on other platforms not being rendered
• Fix UIMessageId problems
• Fix tapping not toggling message timestamp
• Call failure handler in disablePushNotifications

# Interface Changes

None.

# 9.2.0

Released 2020-05-01

# Highlights

We now optimistically render messages outside of live chat, resulting in a snappier user experience. We also introduced two local settings that allow you to prevent the SDK from requesting camera or photo library permissions, thereby preventing the customer from uploading a photo.

# Changes

• Fix bugs related to input masking
• Fix messages getting stuck behind keyboard after resuming
• Implement optimistic rendering of messages outside of live chat
• Introduce local settings that allow you to prevent the SDK from requesting camera or photo library permissions (thereby preventing your customer from uploading a photo).

# Interface changes

• Added ASAPP.shouldRequestCameraAuthorization and .shouldRequestPhotoLibraryAuthorization. Set these to false to prevent the SDK from showing the option to take a photo or choose a photo to upload. These settings will override any remotely-configurable settings.

# 9.1.2

Released 2020-02-26

# Highlights

• Link actions now work in modally-presented component views, such as forms.

# Changes

• Handle link actions in ComponentViewController

# Interface changes

None

# 9.1.1

Released 2020-02-10

# Highlights

• We now provide the SDK as a .framework and an .xcframework with and without bitcode. Please choose the one most appropriate for your development circumstances and let us know.

# Changes

• Instrument enterchat.request.success
• Improve state management of messages
• Remove event type 24
• Presented forms orientation mask support
• Allow tapping elsewhere to dismiss upload options sheet
• Animate unread messages indicator frame along with keyboard
• Make keyboard dismissible on forms
• Ignore quick replies with empty titles
• Observe keyboard changes only at nav level for forms
• Support * for input masking
• Fix photo picker status bar
• Scroll to bottom of table view instead of the top of the last row
• Fix keyboard on forms
• Fix component value not changing when deleting in masked field
• Persist input mask after submission

# Interface changes

None

# 9.1.0

Released 2020-01-08

# Highlights

• Text fields in Component UI forms, if updated, now support basic input masking such as for ZIP codes, possible email addresses, dates, and strict phone number and credit card formats.

# Changes

• [Minor] Input masking
• Fixes input submission for input masking

# Interface changes

None

# 9.0.1

Released 2019-12-06

# Highlights

• Requests now time out based on the remotely-configurable GlobalRequestTimeoutMS setting.

# Changes

• Set request timeout using GlobalRequestTimeoutMS setting

# Interface changes

None

# 9.0.0

Released 2019-11-22

# Highlights

• The ASAPPSDK module is now stable and can be used with different versions of the Swift compiler.

# Changes

• [Major] Rename ASAPP module to ASAPPSDK

# Interface changes

• Renamed the ASAPP module to ASAPPSDK. Please make sure to import ASAPPSDK.

# 8.0.0

Released 2019-11-21

# Important note

Due to a bug in Swift that we failed to notice until it was too late, 8.0.0 is not module-stable and will only work with the Swift 5.1 compiler. We are working to release a patch as soon as possible.

# Highlights

• Added support for iOS 13’s Dark Mode. Please note that for the SDK to properly respond to the system-wide setting, the colors you set should have dark variants (defined in color sets in an asset catalog) and you must set ASAPP.styles.isDarkModeAllowed to true.
• Enabled the Build Libraries for Distribution build option and the -enable-library-evolution compiler flag to support framework ABI stability.

# Changes

• [Major] Support Dark Mode and drop iOS 9 & 10
• Fix chat input state edge case
• Change corner radii
• Instrument more metrics
• Don’t try to reconnect if we’re already connected
• Fix Component UI error message rendering
• Call checkSetupComplete in clearSavedSession

# Interface changes

• Dropped support for iOS 9 and 10. The SDK now requires iOS 11 and up.
• Removed ASAPPButtonColors.init(backgroundColor:).
• Renamed ASAPPColors.dark to .onBackground.
• Renamed ASAPPColors.backgroundPrimary to .background.
• Removed ASAPPColors.backgroundSecondary.
• Removed ASAPPColors.iconTint, which was undocumented.
• Removed ASAPPColors.textShadow.
• Removed ASAPPColors.messagesListGradientColors.
• Added ASAPPColors.messagesListBackground.
• Added ASAPPColors.onPrimary.
• Added ASAPPStyles.isDarkModeAllowed, which defaults to false.