Changelog

8.1.8 - 12/08/22

Bug Fixes:

  • fixed issue where the app could get stuck between Stories, showing half of each side of two Stories and a black gap between them
  • fixed issue of watched Stories not moving to the end of the list
  • fixed issue of grids jumping to the bottom of feeds
  • fixed issue with New Chips flickering when going in and out of More Stories grid

UI Changes:

  • fixed issue with light mode placeholders being used in dark mode for round Story Tiles
  • Story Row container refinements for circular rows, rectangular rows, and Story grids
  • fixed tiles in grids being the wrong aspect ratio
  • fixed issue of Top Stories row appearing as placeholders

8.1.7 - 10/08/22

Bug Fixes:

  • fixed issue with grids only showing the loading state for 2 tiles

New Features:

  • added the contentLength parameter to analytic events - see Analytics for more information

8.1.6 - 10/08/22

Bug Fixes:

  • fixed issue where swiping back to an Ad could make the Ad turn black
  • fixed issue with Ad playing from the point the user stopped watching it at last time the next time the user swipes to it

New Features:

  • enable/disableTracking code

Deprecations and Changes:

  • now request ads from the integrating app every few Stories instead of all at once
  • replace dismissClipView and dismissStoryView with dismissPlayer in Storyteller object

8.1.5 - 05/08/22

Bug Fixes:

  • fixed issue with placeholders not appearing for Story Rows

8.1.3 - 02/08/22

Bug Fixes:

  • fixed issue with playback flailing due to lack of available encoders

8.1.2 - 02/08/22

UI Changes:

  • added theme properties for circular tile border width

  • adjust theme.storyTiles.liveChip.readImage and theme.storyTiles.liveChip.unreadImage to:

    • theme.storyTiles.circularTile.liveChip.readImage
    • theme.storyTiles.circularTile.liveChip.unreadImage
    • theme.storyTiles.rectangularTile.liveChip.readImage
    • theme.storyTiles.rectangularTile.liveChip.unreadImage

8.1.1 - 29/07/22

Bug Fixes:

  • fixes issues related to firing Event Tracking events correctly to provide proper analytics

    • OpenedStory was triggered by automaticPlayback as the openedReason and once with storyListTap - it is now only triggered by storyListTap
    • SkippedPage and CompletedPage were triggered when skipping a page - it is now only triggered by SkippedPage
    • CompletedStory was triggered when a user finished watching an Ad - no Story events are triggered in this instance
    • PausedAdPage was triggered when skipping an Ad - this is now only triggered when the user pauses the Ad
    • ViewedAdPageComplete was triggered when skipping an Ad - this is now only triggered when the viewer has viewed the whole Ad
    • fixed issue to ensure triviaQuizQuestionAnswered fires when the users answers a Trivia Quiz or if they time out on a question
    • fixed issue with triviaQuizScore not returning upon triviaQuizCompleted
    • fixed issue with skippedAd not firing
  • when closing a Story, issue fixed where the user could return to the wrong position in the list view in the row/grid

  • when sharing a Story Page, fixed an issue where the timer didn’t stop to allow the user time to share and return to viewing

  • fixed issue with image answers not appearing on Polls

  • fixed issue with rows with multiple Categories assigned showing Stories swiping into each other and disappearing from the list view

  • fixed issue where Story video preview freezes when swiping back and forth between Stories

  • fixed issue where repeatedly refreshing briefly duplicates rows

  • fixed issue where Story Tiles were incorrectly scaled when displayed across two rows

UI Changes:

  • displaying instructions screen correctly on iPad
  • fixed an issue where switching between light and dark mode didn’t update the theme on circular Story Tiles
  • max length of Story Grid set to 4 Stories in the loading state
  • fixed issue where webview header wasn’t changing colour when switching from light to dark mode

8.1.0 - 13/07/22

Bug Fixes:

  • add empty placeholders when grid view is initialised

8.0.2 - 11/07/22

UI Changes:

  • when displaying the score of a Trivia Quiz to users, the font size has been made bigger, bolder, and the colour has been changed to white
  • corrected spacing between titles and rows/grids across all devices (set to 12px below and above each title)
  • adjusted left margin to be consistent for titles/rows/grids across all devices

Deprecations and Changes:

  • removed topInset and bottomInset for grids
  • ignore startInset and end`Inset for rows inside Home

8.0.1 - 24/06/22

UI Changes:

  • font sizes, cases, and weights corrected
  • adding action buttons instead of swipe ups for Stories
  • support storyTiles.title.show in Story Grids/Rows

New Features:

Deprecations and Changes:

  • removed showPercentBarBackground from theme

7.1.0 - 28/04/22

Bug Fixes:

  • fixed some small issues with Trivia Quizzes

New Features:

  • added support for Live Stories

Deprecations and Changes:

  • changed some Theme properties to allow customization of Live Stories (see Themes for more details)

7.0.1 - 07/04/22

Bug Fixes:

  • fixed a bug where it was possible for the theme to be incorrectly applied to Trivia Quiz Answers

Improvements:

  • improved the performance of loading Stories

7.0.0 - 01/04/22

Bug Fixes:

  • minor UI fixes

Improvements:

  • made it easier to define a custom theme - please see Themes for details

New Features:

  • added support for Trivia Quizzes

6.1.1 - 09/03/22

Bug Fixes:

  • 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 - 16/02/22

Deprecations and Changes:

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

6.0.2 - 02/02/22

Deprecations and Changes:

  • support compile SDK on Xcode 12

6.0.1 - 25/01/22

New Features:

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

6.0.0 - 18/01/22

New Features:

Deprecations and Changes:

  • 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 Themes for more details)
  • changed ListView's theme attribute from StorytellerUiThemeType into StorytellerUiThemeType?

5.0.0 - 18/11/21

Improvements:

  • performance improvements
  • open deep links based on row or shared Storyteller object
  • deep link opened on shared Storyteller object shows only one Story defined in deep link
  • default Stories preloading and optional preloading for selected categories

New Features:

  • added categories support

Deprecations and Changes:

  • moved setting user details from separate method to SDK initialization

4.5.8 - 10/11/21

New Features:

  • added default value for text in ClientAdSwipeUp

4.5.7 - 02/11/21

New Features:

  • added configureSwipeUpWebView delegate callback to StorytellerRowViewDelegate

4.5.6 - 30/09/21

Bug Fixes:

  • 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 - 12/09/21

Bug Fixes:

  • fixed a bug where emojis used in Story title had problems with rendering

Deprecations and Changes:

  • deprecated init for ClientAdSwipeUp and changed its properties name

4.5.4 - 08/09/21

Improvements:

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

4.5.3 - 04/09/21

Improvements:

  • improving the responsiveness of video playback

4.5.2 - 20/08/21

Bug Fixes:

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

4.5.1 - 09/08/21

New Features:

  • added new domains to Storyteller.isStorytellerDeeplink method

4.5.0 - 05/08/21

New Features:

  • 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 - 19/07/21

Bug Fixes:

  • fixed UI issues with circular cell

New Features:

  • added new theme properties for row: newIndicatorTextSize, titleTextSize, titleLineHeight and tilePadding

4.3.0 - 07/07/21

Bug Fixes:

  • fixed a bug which could cause crash on startup in some scenarios
  • minor deep links logic fixes

Improvements:

  • improved Story loading

Deprecations and Changes:

  • changed isStorytellerDeeplink method to public

4.2.2 - 23/06/21

Bug Fixes:

  • minor UI fixes

4.2.1 - 22/06/21

Bug Fixes:

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

4.2.0 - 11/06/21

Bug Fixes:

  • 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

Improvements:

  • preloading data upon initialization

New Features:

  • added themes to increase options for configuring UI
  • added isInitialized property to Storyteller
  • added isPresentingStory property to Storyteller
  • added dismissStoryView method to Storyteller
  • added support for externalApp as a swipe up target

Deprecations and Changes:

  • made dismissStoryView method on StorytellerRowView deprecated
  • made StorytellerRowViewDelegate methods optional

4.1.3 - 15/04/21

Improvements:

  • improving the interaction of the Story View with VoiceOver

4.1.2 - 02/04/21

Bug Fixes:

  • 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

Improvements:

  • reduced timing of Poll animations
  • extended the Page duration when a user selects Poll answer

4.1.0 - 19/03/21

New Features:

  • added support for video backgrounds on Polls

UI Changes:

  • improvements for Polls UI

4.0.4 - 10/03/21

Bug Fixes:

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

4.0.3 - 26/02/21

Bug Fixes:

  • minor UI fixes

Improvements:

  • improving the responsiveness of video playback

New Features:

  • adding the option for a user to save content to their camera roll when the "Share Media" option is selected

4.0.2 - 04/02/21

Bug Fixes:

  • fixed some minor sharing bugs

New Features:

  • added support for text-based Polls in Stories
  • adding Story categories on the OpenedStory Analytics event

4.0.1 - 01/02/21

Bug Fixes:

  • fixed a bug causing slightly delayed Page transitions

New Features:

  • added completion callback for dismissStoryView method

4.0.0 - 22/01/21

Bug Fixes:

  • fixing a bug where it was possible for Video Pages not to play when opened using the openStory or openPage methods

New Features:

  • adding support for Polls in Stories

3.17.4 - 10/12/20

Bug Fixes:

  • 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 - 07/12/20

Bug Fixes:

  • minor UI fixes

3.17.2 - 02/12/20

Improvements:

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

3.17.1 - 20/11/20

Bug Fixes:

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

3.17.0 - 13/11/20

Improvements:

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

3.16.2 - 06/11/20

Improvements:

  • 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 - 29/10/20

Bug Fixes:

  • fixing a bug where onUserActivityOccurred was not called for specific dismiss events
  • fixing a bug which could cause openStory and openPage to not play the requested Story or Page when called

Improvements:

  • adjusting how sharing to Yahoo mail works when using the Share Link option for Pages

New Features:

  • adding video playback events - please see Analytics for details

3.15.1 - 23/10/20

Bug Fixes:

  • fixing a bug where it was possible for there be a black flash when ad playback began

Improvements:

  • 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 - 03/11/20

Bug Fixes:

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

3.15.0 - 16/10/20

Bug Fixes:

  • fixing a bug where dark mode style was applied to instructions screen incorrectly

Deprecations and Changes:

  • compiled with Xcode 12 and iOS 14 SDK

3.14.3 - 02/11/20

Bug Fixes:

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

3.14.2 - 13/10/20

Bug Fixes:

  • fixing a bug where it was possible for the Story Row View to render incorrectly

3.14.1 - 09/10/20

Bug Fixes:

  • 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 - 02/10/20

Bug Fixes:

  • 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

Improvements:

  • 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

3.13.1 - 02/10/20

Bug Fixes:

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

3.13.0 - 18/09/20

Bug Fixes:

  • 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

New Features:

  • adding full and intentional tablet support to the SDK

3.12.1 - 08/09/20

Bug Fixes:

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

Improvements:

  • improvements to playback performance

3.12.0 - 04/09/20

Bug Fixes:

  • 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

Improvements:

  • improving the robustness of parsing App Store URLs for swipe ups

New Features:

  • exposing Story Categories on the getAdsForRow callback - please see the Ads documentation for more details

3.11.2 - 08/09/20

Bug Fixes:

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

3.11.1 - 28/08/20

Improvements:

  • 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 - 24/08/20

Improvements:

  • improving the experience of sharing a Story when using Gmail
  • 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

New Features:

  • 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

3.10.2 - 13/08/20

Bug Fixes:

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

3.10.1 - 10/08/20

New Features:

  • 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 - 07/08/20

Bug Fixes:

  • 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

Improvements:

  • preventing the device screen from sleeping when watching Stories in the Story View

3.9.0 - 31/07/20

Bug Fixes:

  • fixing a UI bug where it was possible for the row to render incorrectly in certain situations
  • 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
  • fixing a bug where Skipped Story events were under reported by the SDK
  • fixing a bug where Dismissed Story events could be over reported 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

Improvements:

  • improving sharing to email apps
  • adjusting the StorytellerRowViewDelegate getAdsForRow callback to allow it to accept nil values for ClientAd

New Features:

  • adding an image of the Story being shared to the suggested email copy (where supported)

3.8.4 - 28/07/20

Improvements:

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

3.8.3 - 27/07/20

Bug Fixes:

  • fixing a bug which could in certain circumstances crash the containing app

New Features:

  • adding dismissStoryView method to StorytellerRowView to allow dismissing of any currently open Story View
  • fixing a bug where it was possible for playback of Image Pages to pause in certain scenarios

3.8.2 - 17/07/20

Bug Fixes:

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

3.8.1 - 16/06/20

Bug Fixes:

  • 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
  • fixing a bug where it was possible for multiple instances of the same ad to appear between a Story in certain circumstances

Improvements:

  • improving the performance of the openPage and openStory methods

3.8.0 - 15/07/20

Improvements:

  • improvements to sharing for iMessage, Facebook, Twitter and Facebook Messenger

UI Changes:

  • increasing the size of the tap target for the Swipe Up UI

3.7.5 -14/07/20

Bug Fixes:

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

3.7.4 - 13/07/20

Bug Fixes:

  • 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 - 10/07/20

Bug Fixes:

  • 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

Improvements:

  • improving the performance of getAdsForRow so that it doesn't wait for the ads to be ready before opening the Story View

3.7.2 - 08/07/20

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

UI Changes:

  • improvements and bug fixes

3.7.1 - 07/07/20

Bug Fixes:

  • fixing a bug where the app could crash when used on iOS 12

Improvements:

  • improving the performance of setUserDetails

UI Changes:

  • improvements and bug fixes

3.7.0 - 06/07/20

Bug Fixes:

  • 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
  • fixing a bug where backgrounding and then foregrounding the Story View did not always resume playback of the current Story

New Features:

  • exposing a new FinishedAd event which rolls up the DismissedAdSkippedAdViewedAdPageComplete and PreviousAd events so it's easier to tell when an ad is not being presented to the user
  • 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

3.6.0 - 01/07/20

Bug Fixes:

  • fixing a bug where it was possible for Story tiles to not be aligned when exiting the Story View
  • 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

Improvements:

  • improving the user experience when navigating to ads

3.5.0 - 24/06/20

Bug Fixes:

  • fixing a bug where it was not possible to tap on the Story title on a tile to open the Story View
  • fixing a bug where backgrounding and foregrounding the app would cause the UI to hide

New Features:

  • adding the ability to supply custom tracking pixels as part of the getAdsForRow request

UI Changes:

  • improvements and bugfixes

Deprecations and Changes:

  • removing onComplete and onError blocks from the initialize method as they were not being used internally

3.4.1 - 22/06/20

3.4.0 - 17/06/20

Bug Fixes:

  • fixing a bug where properties on the AdResponse struct were set to internal rather than public

New Features:

  • adding support for swiping up to the App Store
  • adding onError callback to the openStory and openPage methods for custom error handling when calling those methods - see StorytellerRowViewDelegate for more details

UI Changes:

  • improvements and bugfixes

3.3.0 - 11/06/20

Bug Fixes:

  • fixing a bug where it was possible for dismiss animations to render incorrectly when dismissing an ad
  • fixing some bugs in the Page navigation behavior around which Pages are opened when Stories are read/unread
  • fixing a bug where it wasn't possible to construct a StorytellerRowView programmatically

Improvements:

  • encrypting user access tokens for the Storyteller API at rest
  • ensuring openedReason is included on OpenedAd events
  • ensuring openedReason is included on OpenedPage events
  • 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

New Features:

  • adding a ShareSuccess event to the SDK
  • adding the ability to supply ads to the SDK via the getAdsForRow callback on the StorytellerRowViewDelegate
  • adding new events for tracking user progress through ads - see Analytics for specifics

3.2.0 - 03/06/20

Improvements:

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

3.1.0 - 28/05/20

New Features:

  • adding support for first-party ads loaded from the Storyteller CMS
  • 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

Deprecations and Changes:

  • emitting events related to ads playback via the onUserActivityOccurred callback

3.0.1 - 22/05/20

Bug Fixes:

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

3.0.0 - 20/05/20

New Features:

  • adding onStoriesDataLoadStarted, onStoriesDataLoadComplete, and onStoryDismissed callbacks to StorytellerRowViewDelegate
  • 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

Deprecations and Changes:

  • removing onChannelsDataLoadStarted, onChannelsDataLoadComplete and onChannelDismissed callbacks from StorytellerRowViewDelegate
  • renaming public method openChannel to openStory
  • moving the store of read/unread pages from the server to the client

2.0.0 - 08/05/20

Improvements:

  • improving performance of StorytellerRowView rendering
  • improving logging

New Features:

  • adding the ability to set uiStyle for a StorytellerRowView to control how the row behaves with regards to light/dark mode

Deprecations and Changes:

  • removing dependency on Alamofire
  • removing dependency on DeepDiff
  • removing dependency on RxSwift
PREVIOUS
Forward Arrow