Developers  /  iOS SDK  /  Changelog

        Changelog

        7.1.0

        • added support for Live Stories
        • changed some Theme properties to allow customization of Live Stories (see here for more details Themes)
        • fixed some small issues with Trivia Quizzes

        7.0.1

        • improved the performance of loading stories
        • fixed a bug where it was possible for the theme to be incorrectly applied to Trivia Quiz Answers

        7.0.0

        • added support for Trivia Quizzes
        • made it easier to define a custom theme - please see Themes for details
        • minor UI fixes

        6.1.1

        • fixed a bug where SDK sends wrong version number to api when the Xcode 13 is responsible for app's build version management
        • minor UI fixes on iPad

        6.1.0

        • moved uiStyle attribute from StorytellerTheme to StorytellerListView
        • renamed the uiStyle values to dark, light, and auto (previously Dark, Light, and Auto)

        6.0.2

        • support compile SDK on Xcode 12

        6.0.1

        • added gridDelegate attribute to StorytellerGridView (see here for more details StorytellerGridView)

        6.0.0

        • added StorytellerGridView (see here for more details StorytellerGridView)
        • changed getAdsForRow into getAdsForList
        • changed leftInset and rightInset into insetStart and insetEnd
        • changed StorytellerRowViewCellType into StorytellerListViewCellType
        • changed error parameter of func openStory(id: String = "", animated: Bool = true, onError: ((StorytellerRowViewError) -> Void)? = nil) from StorytellerRowViewError into StorytellerListViewError
        • changed error parameter of func openPage(id: String = "", animated: Bool = true, onError: ((StorytellerListViewError) -> Void)? = nil) from StorytellerRowViewError into StorytellerListViewError
        • changed error parameter of func openDeeplink(url: URL, onError: ((StorytellerListViewError) -> Void)? = nil) from StorytellerRowViewError into StorytellerListViewError
        • renamed class StorytellerRowTheme into StorytellerListTheme
        • renamed protocol StorytellerRowThemeType into StorytellerListThemeType
        • renamed variable row in protocol StorytellerRowThemeType into list
        • renamed class StorytellerRowViewStyle into StorytellerListViewStyle
        • renamed openedReason from storyRowTap to storyListTap
        • renamed playbackMode from row to list
        • added default static attribute theme in Storyteller (see here for more details Theme)
        • changed ListView's theme attribute from StorytellerUiThemeType into StorytellerUiThemeType?

        5.0.0

        • added categories support
        • performance improvements
        • open deeplinks based on row or shared Storyteller object
        • deeplink opened on shared Storyteller object shows only one story defined in deeplink
        • default Stories preloading and optional preloading for selected categories
        • moved setting user details from separate method to SDK initalization

        4.5.8

        • added default value for text in ClientAdSwipeUp

        4.5.7

        • added configureSwipeUpWebView delegate callback to StorytellerRowViewDelegate

        4.5.6

        • fixed issue with scaling of round cell variant
        • fixed issue with story corners not respecting transparency on iOS 15
        • added possibility to add custom text for swipe ups

        4.5.5

        • fixed a bug where emojis used in story title had problems with rendering
        • deprecated init for ClientAdSwipeUp and changed it's properties name

        4.5.4

        • more improvements of the responsiveness of video playback
        • minor fixes

        4.5.3

        • improving the responsiveness of video playback

        4.5.2

        • fixed a bug where share & close buttons didn't work on iOS 15

        4.5.1

        • added new domains to Storyteller.isStorytellerDeeplink method

        4.5.0

        • added possibility to set custom API host
        • added more data to some analytics events: shareButtonTapped and completedPage
        • added none to UserActivity.DismissedReason

        4.4.0

        • added new theme properties for row: newIndicatorTextSize, titleTextSize, titleLineHeight and tilePadding
        • fixed UI issues with circular cell

        4.3.0

        • improved story loading
        • minor deeplinks logic fixes
        • changed isStorytellerDeeplink method to public
        • fixed a bug which could cause crash on startup in some scenarios

        4.2.2

        • minor UI fixes

        4.2.1

        • fixed App Store view disappearing after swipe-up
        • minor UI fixes

        4.2.0

        • added themes to increase options for configuring UI
        • added isInitialized property to Storyteller
        • added isPresentingStory property to Storyteller
        • preloading data upon initalization
        • added dismissStoryView method to Storyteller
        • made dismissStoryView method on StorytellerRowView deprecated
        • made StorytellerRowViewDelegate methods optional
        • added support for externalApp as a swipe up target
        • fixed a bug which could cause the StorytellerRowView overflow over its bounds
        • fixed a bug on iPad where the poll could show as already having been voted in without user interaction

        4.1.3

        • improving the interaction of the story view with VoiceOver

        4.1.2

        • reduced timing of poll animations
        • extended the page duration when a user selects poll answer
        • fixed a bug which could cause the progress bar not restart in some cases
        • fixed a bug which could cause an AD icon on regular pages
        • fixed an issue with tile animation being clipped

        4.1.0

        • improvements for polls UI
        • added support for video backgrounds on polls

        4.0.4

        • fixing a bug where it was possible for SwipedUp events to be recorded twice in certain circumstances

        4.0.3

        • improving the responsiveness of video playback
        • adding the option for a user to save content to their camera roll when the "Share Media" option is selected
        • minor UI fixes

        4.0.2

        • added support for text-based polls in stories
        • adding Story categories on the OpenedStory Analytics event
        • fixed some minor sharing bugs

        4.0.1

        • fixed a bug causing slightly delayed page transitions
        • added completion callback for dismissStoryView method

        4.0.0

        • adding support for polls in stories
        • fixing a bug where it was possible for video pages not to play when opened using the openStory or openPage methods

        3.17.4

        • fixing a bug where there was a noticeable change in the colors of a video ad as it loaded
        • fixing a bug where it was possible for the close button in the Story View to be unresponsive in certain circumstances

        3.17.3

        • minor UI fixes

        3.17.2

        • ensuring that the Story view is always rendered in portrait mode for iPhone devices

        3.17.1

        • fixed issue with gestures not responsible when there are multiple UIWindows
        • fixed short UI freeze after getting getAdsForRow callback

        3.17.0

        • further improvements to the handling of the device's silent toggle

        3.16.2

        • not sending extra parameters to tracking pixels passed in to the SDK from client supplied ads
        • not URL encoding tracking pixel URLs passed in to the SDK from client supplied ads

        3.16.0

        • adding video playback events - please see Analytics for details
        • fixing a bug where onUserActivityOccurred was not called for specific dismiss events
        • adjusting how sharing to Yahoo mail works when using the Share Link option for pages
        • fixing a bug which could cause openStory and openPage to not play the requested story or page when called

        3.15.1

        • fixing a bug where it was possible for there be a black flash when ad playback began
        • adjusting headers in a dependency to remove any warnings about deprecated methods when using the iOS 14 SDK
        • adjusting the initialize method errors - see Getting Started for more details
        • improving the handling of retries when loading assets

        3.15.0.1

        • fixing a bug where onUserActivityOccurred was not called for specific dismiss events

        3.15.0

        • fixing a bug where dark mode style was applied to instructions screen incorrectly
        • compiled with Xcode 12 and iOS 14 SDK

        3.14.3

        • fixing a bug where onUserActivityOccurred was not called for specific dismiss events

        3.14.2

        • fixing a bug where it was possible for the Story row view to render incorrectly

        3.14.1

        • fixing a bug where it was possible for the close button to not be tappable on tablets in certain scenarios
        • fixing a bug where the tablet layout was rendered on the iPhone SE

        3.14.0

        • adjusting the behavior of the instructions modal on tablets so that it appears over the story view rather than over the place in the app where it was presented from
        • improving the prefetching of initial page images and playcards
        • allowing rotation on tablet devices when in the story view
        • fixing a bug where it was possible for a loading indicator to appear but not spin when a user was using a slower network connection

        3.13.1

        • fixing a bug where the tablet layout was rendered on the iPhone SE

        3.13.0

        • adding full and intentional tablet support to the SDK
        • fixing a bug where it was possible for the silent toggle not to be respected on the device when backgrounding and foregrounding the containing app

        3.12.1

        • fixing a bug which made it possible for the SDK to cause an integrating app crash in certain scenarios
        • improvements to playback performance

        3.12.0

        • exposing Story Categories on the getAdsForRow callback - please see the Ads documentation for more details
        • improving the robustness of parsing App Store URLs for swipe ups
        • fixing a bug where it was possible for slide playback to terminate prematurely in certain circumstances
        • fixing a bug where it was possible for the first frame of the previous page to flash before playback began on the next page
        • fixing a bug where it was possible for playback to freeze when a user shared a page
        • fixing a bug where it was possible for playback to freeze when a user tapped back to a previously viewed video slide

        3.11.2

        • fixing a bug which made it possible for the SDK to cause a crash in certain scenarios

        3.11.1

        • improving the behavior of the row view when it is refreshed to prevent an edge case where it was possible for placeholders to be displayed instead of the correct data
        • further improvements to the handling of the device's silent toggle

        3.11.0

        • improving the experience of sharing a story when using Gmail
        • adding support for swiping up to a location within the integrating app or to the App Store from within Client Supplied Ads - see Ads for more details
        • adjusting the initialization flow of the SDK - see Getting Started for more details
        • improving handling of respecting the device's silent toggle to cover more scenarios where it was not respected

        3.10.2

        • fixing a bug where it was possible for the SDK to crash when rendering the StorytellerRowView

        3.10.1

        • adding a method to the StorytellerRowViewDelegate called tileBecameVisible to allow the integrating app to be notified when a tile is visible on screen

        3.10.0

        • preventing the device screen from sleeping when watching stories in the Story View
        • fixing a crash when prefetching videos for upcoming pages
        • fixing a bug where the swipe up UI could be briefly displayed on a page which did not have a swipe up action enabled

        3.9.0

        • fixing a UI bug where it was possible for the row to render incorrectly in certain situations
        • improving sharing to email apps
        • adding an image of the story being shared to the suggested email copy (where supported)
        • fixing a bug where it was possible for the device's silent toggle to be ignored in certain scenarios
        • fixing a bug where backgrounding the app when the share dialog was open would cause playback to resume when the app was returned to the foreground
        • adjusting the StorytellerRowViewDelegate getAdsForRow callback to allow it to accept nil values for ClientAd
        • fixing a bug where Skipped Story events were underreported by the SDK
        • fixing a bug where Dismissed Story events could be overreported by the SDK when a user successfully shared a story
        • fixing a bug where tapping back on the first page of a story could fire the Previous Story event erroneously

        3.8.4

        • adjusting the method email sharing uses in order to support a wider variety of email clients

        3.8.3

        • adding dismissStoryView method to StorytellerRowView to allow dismissing of any currently open Story View
        • fixing a bug which could in certain circumstances crash the containing app

        3.8.2

        • fixing a bug where it was possible for playback of image pages to pause in certain scenarios

        3.8.1

        • fixing a bug where it was possible for two Story Views to layer on top of each other if one was already open when using openPage/openStory
        • improving the performance of the openPage and openStory methods
        • fixing a bug where it was possible for multiple instances of the same ad to appear between a story in certain circumstances

        3.8.0

        • increasing the size of the tap target for the Swipe Up UI
        • improvements to sharing for iMessage, Facebook, Twitter and Facebook Messenger

        3.7.5

        • fixing a bug where the correct number of stories were not displayed in the row

        3.7.4

        • fixing a bug where it was possible for story playback to lock up
        • fixing a bug where backgrounding the app with the instructions screen visible would cause story playback to begin

        3.7.3

        • improving the performance of getAdsForRow so that it doesn't wait for the ads to be ready before opening the Story View
        • fixing a bug where if the user cancelled sharing then playback would resume with the native share sheet still open
        • fixing a bug where story playback could resume under a swiped up web view in certain circumstances
        • fixing a bug where it was possible to miss seeing a final trailing ad in certain circumstances

        3.7.2

        • UI improvements and bug fixes
        • fixing a bug where it was possible for story playback not to pause on devices with a home button
        • fixing a bug where story playback would resume under a swiped up web view
        • fixing a bug where after swiping up on a page it was possible for the page to become unresponsive

        3.7.1

        • improving the performance of setUserDetails
        • fixing a bug where the app could crash when used on iOS 12
        • UI improvements and bug fixes

        3.7.0

        • exposing a new FinishedAd event which rolls up the DismissedAd, SkippedAd, ViewedAdPageComplete and PreviousAd events so it's easier to tell when an ad is not being presented to the user
        • fixing a bug where it was possible for Analytics events to fire if a user began swiping a page but did not complete the swipe
        • passing the adView parameter on OpenedAd and FinishedAd events which contains a reference to the view in which the ad was rendered
        • adding the advertiserName parameter to ad analytics events
        • adding the ability to pass a rowHeight parameter to a StorytellerRowView in order to force it to render at a specific height - please see StorytellerRowView for more information
        • fixing a bug where backgrounding and then foregrounding the Story View did not always resume playback of the current story

        3.6.0

        • fixing a bug where it was possible for Story tiles to not be aligned when exiting the Story View
        • improving the user experience when navigating to ads
        • fixing a bug where it was possible for Story events to fire for Ads
        • fixing a bug where it was possible for ResumedAdPage events to be double fired for image pages

        3.5.0

        • UI improvements and bugfixes
        • removing onComplete and onError blocks from the initialize method as they were not being used internally
        • fixing a bug where it was not possible to tap on the story title on a tile to open the Story View
        • adding the ability to supply custom tracking pixels as part of the getAdsForRow request
        • fixing a bug where backgrounding and foregrounding the app would cause the UI to hide

        3.4.1

        3.4.0

        • fixing a bug where properties on the AdResponse struct were set to internal rather than public
        • adding support for swiping up to the App Store
        • UI improvements and bugfixes
        • adding onError callback to the openStory and openPage methods for custom error handling when calling those methods - see StorytellerRowView for more details

        3.3.0

        • adding a ShareSuccess event to the SDK
        • fixing a bug where it was possible for dismiss animations to render incorrectly when dismissing an ad
        • encrypting user access tokens for the Storyteller API at rest
        • fixing some bugs in the page navigation behavior around which pages are opened when stories are read/unread
        • adding the ability to supply ads to the SDK via the getAdsForRow callback on the StorytellerRowViewDelegate
        • ensuring openedReason is included on OpenedAd events
        • ensuring openedReason is included on OpenedPage events
        • adding new events for tracking user progress through ads - see Analytics for specifics
        • ensuring that DismissedAd events report the durationViewed and pagesViewedCount properties
        • ensuring that any analytics properties which represent an index begin counting at 1 instead of 0
        • fixing a bug where it wasn't possible to construct a StorytellerRowView programmatically

        3.2.0

        • improving the rendering performance of the StoryRowView when using the square layout

        3.1.0

        • adding support for first-party ads loaded from the Storyteller CMS
        • emitting events related to ads playback via the onUserActivityOccurred callback
        • adding the ability to disable the story icon in the story view on a per-tenant basis
        • adding the ability to include a timestamp in the story view on a per-tenant basis
        • adding the ability to share a link configured in the CMS for each page (rather than the page's media) and the ability to configure this on a per-tenant basis

        3.0.1

        • fixing issue where XCFrameworks were only usable when disabling bitcode
        • fixing issue where UserActivityData struct did not have publicly visible members

        3.0.0

        • removing onChannelsDataLoadStarted, onChannelsDataLoadComplete and onChannelDismissed callbacks from StorytellerRowViewDelegate
        • adding onStoriesDataLoadStarted, onStoriesDataLoadComplete, and onStoryDismissed callbacks to StorytellerRowViewDelegate
        • renaming public method openChannel to openStory
        • moving the store of read/unread pages from the server to the client
        • adding support for distributing the SDK as XCFrameworks
        • (beta) adding onUserActivityOccurred callback to StorytellerRowViewDelegate so the containing app can receive notifications when users take actions within the SDK

        2.0.0

        • Adding the ability to set uiStyle for a StorytellerRowView to control how the row behaves with regards to light/dark mode
        • Improving performance of StorytellerRowView rendering
        • Removing dependency on Alamofire
        • Removing dependency on DeepDiff
        • Improving logging
        • Removing dependency on RxSwift
        PREVIOUS
        Forward Arrow
        NEXT
        Additional MethodsForward Arrow