Changelog
8.5.0 - 19/01/23
Breaking changes:
SDK Repackaging was done to organise the code better. Please update Storyteller imports.
Old class |
New class |
com.storyteller.domain.StorytellerListViewCellType |
com.storyteller.domain.entities.StorytellerListViewCellType |
com.storyteller.services.Error |
com.storyteller.domain.entities.Error |
com.storyteller.domain.AdResponse |
com.storyteller.domain.entities.ads.AdResponse |
com.storyteller.domain.ClientStory |
com.storyteller.domain.entities.ads.ClientStory |
com.storyteller.domain.ListDescriptor |
com.storyteller.domain.entities.ads.ListDescriptor |
com.storyteller.domain.UserActivity |
com.storyteller.domain.entities.UserActivity |
com.storyteller.domain.UserActivityData |
com.storyteller.domain.entities.UserActivityData |
com.storyteller.domain.UserInput |
com.storyteller.domain.entities.UserInput |
com.storyteller.domain.ClientAd |
com.storyteller.domain.entity.ads.ClientAd |
Bug Fixes:
- fixed a bug with
onPlayerDismissed
callback
- fixed a bug with
onDataLoadComplete
callback
- fixed a bug with Video from previous story playing in background
- fixed bugs with some parameters not set for the analytic events
Improvements:
- added
topInset
and bottomInset
to grids - - please see Themes for more details
- added better support for open/close transitions using
activityReentered
method - please see Analytics for more details
8.4.0 - 16/12/22
Bug Fixes:
- fixed a bug with the loading spinner on Clips
- fixed rare bug with Story transitions
- fixed a bug that causes Quiz Pages to be answered when tapping back
- fixed an animation bug with Story tiles
Improvements:
- improvements to the prefetching of Clips' playcard image
- implemented a more efficient UserActivity reporting system
- corrected the use case of thumbnails and playcards
- implemented single ExoPlayer to improve video playback
8.3.4 - 21/12/22
Bug Fixes:
- fixed a bug with
dismissPlayer
on Clips
8.3.3 - 21/12/22
Bug Fixes:
- added Clip Collection and Clip Categories event data for all Clip analytic events
8.3.2 - 21/12/22
Bug Fixes:
- Skipped Ad events are now recorded when tapping on an ad and swiping left on an ad
Improvements:
- added Current Category to the event data for Story and Ad analytic events
8.3.1 - 15/12/22
Improvements:
- added support for multiple font weights
- replaced SHARE_TAPPED event with SHARE_BUTTON_TAPPED for event consistency between Stories and Clips
8.3.0 - 06/12/22
Bug Fixes:
- fixed bug when a user taps outside a Story border on Quizzes
- fixed default value for
answeredMessageTextColor
- fixed bug with presenting rounded corners on Stories
- fixed bug with tracking pixels
Improvements:
- added additional properties to ad events to help identify individual ads
- improvements to the positioning of Action buttons
- modified the
getAdsForList
callback to provide more ad information
- adjusted the timestamp property so timescales are updated for each new Page
8.2.9 - 29/11/22
Bug Fixes:
- implemented a solution for a shared animation bug on Android 5 to Android 9 when targeting
singleInstance
activity
Improvements:
8.2.8 - 25/11/22
Bug Fixes:
- fixed bug with Live Chip properties
- fixed bug with
onCurrentVideoPlayerChanged
event
- fixed bug that could cause a
NullPointerException
- fixed bug that could cause a Story to not be marked as read when quickly switching Pages
8.2.7 - 22/11/22
Bug Fixes:
- fixed bug with Stories not opening in Single Story mode when using deep links
- fixed bug with user activity reports with Stories launched via deep link
- fixed bug that causes delegates to be disconnected in certain instances
- fixed bug with opening Clips whilst reloading data
8.2.6 - 15/11/22
Bug Fixes:
- fixed rare crash when opening player
8.2.5 - 11/11/22
Bug Fixes:
- fixed bug with Story playback when tapping quickly through Stories
- fixed bug that could cause rare adapter crash
- fixed bug with video playback when changing user
Deprecations and Changes:
- ads are now requested after every Story to align ad call logic with iOS SDK
8.2.4 - 04/11/22
Bug Fixes:
- fixed bug that could cause the same Story to play after ad insertion
- fixed bug that could cause rare crash after opening webpage links
- exposed classes needed to support React Native
8.2.3 - 01/11/22
Bug Fixes:
- fixed bug that could cause crash when changing Page whilst the player is being closed
- fixed bug that could cause tracking events to be started incorrectly
Improvements:
- reduced memory footprint to improve playback
- stopped empty or failed items appearing in StorytellerHomeView on rare occasions
- implemented improved retry policy
Deprecations and Changes:
- removed all open methods from StorytellerListViews to just leave static methods
8.2.2 - 25/10/22
Bug Fixes:
- fixed rare crash when opening player
Improvements:
8.2.1 - 21/10/22
New Features:
- implemented preloading for Stories and Clips
- added support for selective Story caching for Story rows
Bug Fixes:
- fixed bug with the opening animations of Trivia Quizzes
- fixed bug with fetching ads after using airplane mode
- fixed bug with video playback getting stuck
- fixed bug with view model that could cause Story crashes
Improvements:
- improved analytics handling
- improvements in handling of DeepLinkManager
- improvements in data use cases
8.2.0 - 11/10/22
New Features:
- added support for Clips and Collections
Bug Fixes:
- fixed bug that delays dismissing of an opened Story
- fixed inconsistencies with
theme.engagementUnits.poll.answeredMessageTextColor
- fixed bug with
theme.player.liveChipImage
and theme.primitives.cornerRadius
on Poll answers and Story Action buttons
- fixed bug that could cause Story to freeze when tapping fast
- fixed bugs with fresh tenants swiping up on an ad and closing ads
- fixed swipe down animation bug
- fixed bug with preview transitions on tablets
- fixed bug that could cause user to move to a Story row instead of a Story when closing web
Improvements:
- added refresh button to Story videos
- new and improved mechanism for batch ad handing, audio manager focus handling, events and callbacks
- improved handling of media sharing
- new and improved mechanisms for analytics and opening Story/Page IDs
- performance improvements for Stories and Clips loading times
- adding theme
theme.storyTiles.rectangularTile.unreadIndicator.textSize
- making all tile themes respect UiStyle for all tile types
- open/close shared transition handling improvements
8.1.15 - 26/10/22
Bug Fixes:
- fixed a bug where it wasn't possible to select files inside the Action Web View
New Features:
- added support for External Action Links
8.1.14 - 17/10/22
New Features:
- added the ability to open a clip or collection directly using the
openCollection
method
8.1.13 - 21/09/22
Bug Fixes:
- fixed option to save Story assets from a Story not displaying correctly
8.1.12 - 01/09/22
Bug Fixes:
- fixed Story sharing issue between iOS and Android
- fixed Quiz sharing issues
8.1.11 - 24/08/22
Bug Fixes:
- fixed occasional crash when closing player
- fixed reload button visibility not working
Improvements:
- renamed
Storyteller.isPresentingStory
to Storyteller.isPlayerVisible
UI Changes:
- improving the Story Player UI on tablet
8.1.10 - 19/08/22
Bug Fixes:
- fixed issue of duplicate apps when share sheet opens
- fixed issue where a Page with a Poll plays audio from the previous Page after sharing
- fixed issue of Poll sharing only working if the Poll has been answered and shared from another Android device
- fixed issue of video playback not playing on Video Poll after watching a Video Page
- fixed issue where the
SHARE_SUCCESS
event was not sent
Improvements:
- improving the Story Player UI
- improving the share sheet
UI Changes:
- navigation buttons added back into Stories
- status bar visible in Stories
8.1.9 - 12/08/22
Bug Fixes:
- fixed an issue where the share button could be cropped on smaller devices
- fixed issue of grid being cropped on navigation to more Stories
- fixed an issue where a placeholder could be briefly visible after close animation is finished
Improvements:
- improved audio focus handling on Android API < 26 (Oreo)
New Features:
- added
contentLength
parameter for analytics events - please see Analytics for more details
UI Changes:
- general UI refinements for Story Tiles and Story Player
- ensured all grid tiles have corner radii
8.1.8 - 11/08/22
Bug Fixes:
- fixing some minor issues with the tile layouts
Improvements:
- improving the audio focus handling when the Story Player is open
8.1.7 - 05/08/22
Improvements:
- update client ads
getAdsForList
public api
- improve polls UI
8.1.6 - 02/08/22
New Features:
- add support for circular tile border theming
- add support for circular tile custom live chip theming
8.1.5 - 02/08/22
Bug Fixes:
- fix a crash caused by triggering web action button
- improve story player UI
- fix row/grid
displayLimit
not working for placeholders
8.1.4 - 27/07/22
Bug Fixes:
- fix row/grid placeholders styling for light/dark modes
Improvements:
- improve light/dark mode theme compatibility
8.1.3 - 25/07/22
New Features:
- add support for multiple row/grids with the same categories
8.1.2 - 25/07/22
Bug Fixes:
- fix bug where sometimes no Stories could be shown when categories are set
Improvements:
- improve performance or rows/grids inside recycler views
8.1.1 - 22/07/22
Bug Fixes:
- fixing a rare crash which could occur when tapping on a web action button
- fixing an issue where the share button for Polls was misaligned
UI Changes:
- improving the layout of the round Story tile items
Deprecations and Changes:
- removing
topInset
and bottomInset
from grids
8.1.0 - 13/07/22
Improvements:
- improving the video playback experience
8.0.3 - 11/07/22
Bug Fixes:
- fix bug where live chip was incorrect for read/unread story tiles
- fix inconsistent round tile sizes for varying lines of title text
- fix title text alignment in round tiles
8.0.2 - 28/06/22
Bug Fixes:
- fixing an issue where it was possible for a progress indicator to stay on a Poll page
- fixing an issue where the live chip was not aligned correctly on a tile
- fixing an issue with
lists.grid.columns
in theme
8.0.1 - 24/06/22
Bug Fixes:
- fixing an issue with R8 and the SDK package name
- fixing an issue where it was possible for video playback to not start when viewing a video Page
- fixing an issue where it was possible for Stories not not be marked as Read
- fixing an issue where it was possible for video playback to start in the background
- fixing an issue where it was possible for video playback to freeze unexpectedly
- fixing an issue where it was possible for the instructions screen to layout incorrectly
- fixing an issue where it was possible for the share button to not be clickable in certain scenarios
Improvements:
- improving the performance of the Story Player
New Features:
- adding the ability to enable/disable Storyteller event tracking via the SDK method
enableEventTracking()
and disableEventTracking
- please see Additional Methods for more information
- adding action buttons instead of swipe ups for Stories
- adding
displayLimit
parameter to StorytellerListView
- please see Configuring a StorytellerListView
UI Changes:
- improving the UI for Polls and Quizzes
Deprecations and Changes:
7.1.0 - 29/04/22
Bug Fixes:
- fixing an issue with the instructions screen UI
New Features:
- adding support for Live Stories
- adding additional attributes to support Live Stories theming - please see Custom Themes for details
UI Changes:
- improving UI/UX experience in Story Player
7.0.3 - 12/04/22
Bug Fixes:
- fixing a dependency clash with Koin library
7.0.2 - 0/04/22
Bug Fixes:
- fixing an issue with ReactNative
7.0.1 - 04/04/22
Bug Fixes:
- fixing an issues with quizzes and theme colors
- fixing an issue where the
UiTheme
had obfuscated name
7.0.0 - 01/04/22
Bug Fixes:
- fixing an issue where is was possible foe the new indicators to appear on placeholders
- improving the category caching for faster load times
- fixing a crash which could occur on initialization
- fixing an issue where it was possible for the global delegate not to register
- fixing an issue where it was possible for the share button to disappear after swiping up on a Story
Improvements:
- making it easier to define a custom theme - please see Themes for details
New Features:
- adding support for Trivia Quizzes
6.2.0 - 25/02/22
Improvements:
- improved support for multiple
StoryListViews
inside a RecyclerView
6.1.4 - 14/03/22
Bug Fixes:
- fixing an issue with the navigation for the video pages on Android 12
6.1.3 - 08/03/22
Bug Fixes:
- fixing a crash which could occur on the open/close story animation
- fixing an issue with the
primaryTextColor
- fixing a crash which could occur when opening the web link
6.1.2 - 23/02/22
Bug Fixes:
- fixing obfuscation issues
6.1.1 - 23/02/22
Bug Fixes:
- fixing an issue with the reloading of the stories list
- fixing an issue with the story tiles flickering when reloading
Improvements:
- improving the story tile resizing
Deprecations and Changes:
pagesViewedCount
is public again
6.1.0 - 16/02/22
Bug Fixes:
-
fixing an issue with navigation which could occur when ads are enabled
-
fixing an issue with poll vote calculations
-
fixing a bug where the story list tiles were not updated properly on older Android versions
-
fixing an issue with the colors from the theme not being applied properly for StorytellerListViews
Deprecations and Changes:
6.0.2 - 07/02/22
Bug Fixes:
- fixing obfuscation issues
6.0.1 - 03/03/22
Bug Fixes:
- fixing an issue which could occur when opening a story when in the landscape orientation
- fixing a crash which could occur on the open/close story animation
Improvements:
- improving the poll UI
- improving the UI on the devices with notch
6.0.0 - 17/01/22
Improvements:
- Improving the scaling behavior of story tiles
- Improvements and bugfixes in how themes are handled
New Features:
- Added
StorytellerGridView
(see here for more details StorytellerGridView)
- Adding the ability to override the theme on a per list basis
Deprecations and Changes:
- Public API breaking changes:
- package
com.storyteller.ui.row
renamed to com.storyteller.ui.list
StorytellerRowViewDelegate
renamed to StorytellerListViewDelegate
StorytellerDelegate
's getAdsForRow
renamed to getAdsForList
StorytellerRowView
's insetRight
and insetLeft
renamed correspondingly to insetStart
and insetEnd
Theme
class' property row
renamed to list
RowViewTheme
class renamed to ListViewTheme
StorytellerRowViewCellType
renamed to StorytellerListViewCellType
StorytellerRowViewStyle
renamed to StorytellerListViewStyle
OpenedReason
's enum value STORY_ROW_TAPPED
renamed to STORY_LIST_TAP
, tracking string story_row_tapped
renamed to story_list_tapped
StoryPlaybackMode
's enum value ROW
renamed to LIST
, tracking string: row
renamed to list
5.0.8 - 08/02/22
Bug Fixes:
- fix for race conditions in case of rapid onPause/onResume scenarios
5.0.7 - 31/01/22
Bug Fixes:
- fixing a potential issue which could occur when running unit tests with Storyteller
5.0.6 - 25/01/22
Bug Fixes:
5.0.5 - 03/01/22
Bug Fixes:
- fixing a concurrency issue
5.0.4 - 15/12/21
Bug Fixes:
- fixing a crash which could occur when skipping through the pages fast
5.0.3 - 14/12/22
Bug Fixes:
- fixing a crash which could occur when invoking
Storyteller.initialize
multiple times
5.0.2 - 02/12/21
Bug Fixes:
- fixing a bug with the user activity data parsing
Deprecations and Changes:
- removing all
jcenter()
dependencies
5.0.1 - 24/11/21
Bug Fixes:
- fixing a UI glitch where the initial story page could be shown when switching between the pages
- fixing a crash which could happen when using delegates,
configureSwipeUpWebView(...)
is now mandatory to override
- fixing a bug which could occur when using Storyteller ads
5.0.0 - 18/11/21
Improvements:
- improving sending of analytics events
New Features:
- adding support for categories - please see StorytellerRowView for details
- adding support for opening the story player in single story mode without the
StorytellerRowView
- please see AdditionalMethods for details
- adding additional param
storyPlaybackMode
to analytics events - please see Analytics for details
Deprecations and Changes:
- splitting
StorytellerRowViewDelegate
into two separate delegates - please see StorytellerDelegate and StorytellerRowViewDelegate for details
- removing the
cellScale
parameter from the StorytellerRowView
in favour of auto adapting to the parent's view height
- removing callbacks from the
reloadData()
method
4.5.11 - 03/11/21
Bug Fixes:
- fixing a crash which could occur when sharing the story on Android 12
4.5.10 - 02/11/21
New Features:
- adding additional method
configureSwipeUpWebView(webview: Webview, url : String?, favicon: Bitmap?)
to allow additional configuration of the WebView - please see StorytellerRowViewDelegate
4.5.9 - 20/10/21
Bug Fixes:
- fixing a crash which could occur when opening the story and scrolling the row in a container
4.5.8 - 13/10/21
Bug Fixes:
- fixing a problem with ads and navigation
- fixing a UI issue with the rounded corners on tablets
4.5.7 - 30/09/21
Bug Fixes:
- fixing a potential clash with resource names
- fixing a crash which could occur when using a malformed swipe up url
4.5.6 - 24/09/21
Bug Fixes:
- fixing Windows build issue originating in the kotlinModule compilation artifact containing characters disallowed in windows filesystem
4.5.5 - 13/09/21
Bug Fixes:
- fixing a bug where the swipe up to
in_app
links was not working
New Features:
- adding additional method
openDeepLink(String,Boolean,(Error) -> Unit)
to make Storyteller SDK integration easier - please see AdditionalMethods and Deep Linking
- adding
secondaryColor
property to themes - please see Themes for details
4.5.4 - 31/08/21
Bug Fixes:
- fixing a bug where the story could not be closed if the delegate was not set
- fixing a bug where the poll percentages could show invalid values when the orientation is changed
- fixing a rare crash which could occur when opening poll stories
Improvements:
4.5.3 - 11/08/21
Bug Fixes:
4.5.2 - 11/08/21
Bug Fixes:
- fixing a bug where the poll answers could be cut on some devices
New Features:
- adding additional method
isStorytellerDeepLink(String)
to make Storyteller SDK integration easier - please see AdditionalMethods
4.5.1 - 06/08/21
Bug Fixes:
- fixing a tablet bug where the story player could be frozen when changing orientation
4.5.0 - 05/08/21
Improvements:
- minor performance improvements
4.4.2 - 03/08/21
Bug Fixes:
- fixing a bug where the
COMPLETED_STORY
event could be triggered too early
Improvements:
- improving the story tile loading states
4.4.1 - 28/07/21
Improvements:
- improve in app swipe up handling
New Features:
- add
animated
parameter for openPage
and openStory
public methods
4.4.0 - 21/07/21
Bug Fixes:
- fixing a bug which could occur when updating the story with new pages
- fixing a UI issue with the instructions screen which could appear on some smaller tablets
- fixing a bug where the story could be opened multiple times
Improvements:
- resources can be used to set the theme properties - please see Themes for details
4.3.3 - 06/07/21
Bug Fixes:
- fixing a crash which could occur during the preload of images
4.3.2 - 02/07/21
Bug Fixes:
- added another fix for crash caused by connection timeouts
- fixing a bug where the swipe ups were sometimes not working
4.3.1 - 02/07/1
Bug Fixes:
- added a fix for crash caused by connection timeouts
4.3.0 - 01/07/21
Bug Fixes:
- fixing a crash which could occur when using custom ads
- fixing a bug where the poll answers could start flickering
Improvements:
- improving the page loading states
4.2.0 - 10/06/21
Improvements:
- internalizing the Exoplayer
2.14.0
to remove any version conflicts with the client applications
New Features:
- adding support for themes - please see Themes for details
- adding additional methods to make Storyteller SDK integration easier - please see AdditionalMethods
4.1.3 - 14/04/21
Bug Fixes:
- fixed a bug where the poll video could be played after changing the page
- fixed a crash which could occur when changing the orientation on tablets
Improvements:
- improved poll UI and animations
4.1.2 - 02/04/21
Bug Fixes:
- fixed an issue with tile animation being clipped
UI Changes:
- extended the page duration when a user selects poll answer
- improved poll UI and animations
4.1.1 - 24/03/21
Bug Fixes:
- fixing a bug where the navigation on poll pages could stop working
Improvements:
- improving the network request format
4.1.0 - 19/03/21
Bug Fixes:
- fixing a crash which could occur when sending analytics
- fixing a bug where the instructions modal button could appear too low on tablets
- fixing a bug where the story player could be closed when navigating through the stories which were read
Improvements:
4.0.5 - 01/03/21
Bug Fixes:
- fixing a crash which could occur when opening a story
Improvements:
- improving the animation when swiping between stories for Android 11 devices
4.0.4 - 15/02/21
Bug Fixes:
- fixing a crash which could occur when opening a story from a deep link
4.0.3 - 11/02/21
Improvements:
- improving the preloading of videos on poll pages
- improving sharing to different apps
4.0.2 - 04/02/21
Bug Fixes:
- fixing a crash which could occur when closing the story view
- fixing a bug where changing the
rowScale
property on the Storyteller Row had no effect
4.0.1 - 01/12/21
Bug Fixes:
- fixing some visual bugs which could occur on the poll pages
- fixing a crash which could occur when closing the story view
New Features:
- adding support for video backgrounds on poll pages
4.0.0 - 25/01/21
Bug Fixes:
- fixing a bug where it was possible for swipe ups to stop working
- fixing a crash which could occur when saving analytics data
Improvements:
- performance improvements for video and image pages
New Features:
- adding support for poll pages
- adding support for multiple instances of the Story Row in a single app
Deprecations and Changes:
- changing the method signatures of
openStory
, openPage
and reloadData
- see StorytellerRowView for more details
3.17.5 - 15/12/20
Bug Fixes:
- fixing a bug where the in-app browser address bar could be white in night mode
3.17.4 - 10/12/20
Bug Fixes:
- fixing a bug where the read stories could be shown when tapping on unread story
- fixing a bug where the profile image was not shown for ads
- fixing a bug where the swipe up UI could be shown even if it was disabled
- fixing a bug with the onboarding screen margins
3.17.2 - 10/12/20
Bug Fixes:
- fixed a bug where an incorrect border color is applied to a story row item after it became read upon closing the story viewer
3.17.1 - 30/11/20
Bug Fixes:
- fixing a crash which could occur when preloading videos for stories
3.17.0 - 27/11/20
Bug Fixes:
- fixing a bug which could cause video playback to resume when a user was swiping to change stories
- fixing a crash which could occur when preloading videos for ads
- fixing a crash for some customers which could occur during swiping on Android 11
3.16.4 - 18/11/20
Bug Fixes:
- fixing a bug where the blank page was opened instead of a story
3.16.3 - 18/11/20
Bug Fixes:
- fixing potential null pointer exceptions
- fixing a bug where the Play Store was not opened, when swiping up on a page with redirect
- fixing a bug where the
resumedAdPage
event was triggered too often
- fixing a bug where the read status of a story was not saved
3.16.2 - 06/11/20
Bug Fixes:
- fixing a bug introduced in 3.16.0 where it was possible for incorrect tracking pixels to be called for integrating app ads
Improvements:
- improving video preloading with the new version of Exoplayer
Deprecations and Changes:
- not sending extra parameters to tracking pixels supplied via integrating app ads
3.16.1 - 02/11/20
Bug Fixes:
- fixing a crash which could occur when swiping to interact with the Story View
3.16.0 - 30/10/20
Bug Fixes:
- fixing a crash which could occur when watching stories and changing from an image page to a video page
- fixing the alignment of the dismiss icon within the story view relative to the story title
- fixing a bug where if the system dark mode was changed when the story view was opened, the current story would persist behind other stories
- fixing a bug where the new tag could not be removed from the story row tiles in certain circumstances
Improvements:
- improving the performance of the story view when quickly transitioning between pages
New Features:
- adding video playback events - please see Analytics for details
3.15.5 - 06/11/20
Bug Fixes:
- fixing a bug introduced in 3.15.3 where it was possible for incorrect tracking pixels to be called for integrating app ads
3.15.4 - 04/11/20
Bug Fixes:
- fixing a crash which could occur when swiping to interact with the Story View
3.15.3 - 02/11/20
Bug Fixes:
- fixing a crash which could occur when swiping to interact with the Story View
3.15.2 - 29/10/20
Bug Fixes:
- fixing a crash which could occur when swiping to interact with the Story View
- upgrading Exoplayer dependency to version 2.11.3
3.15.1 - 22/10/20
Improvements:
- improving the smartphone onboarding layout
- improving the animation when story is opened
- improving the preloading of videos
Deprecations and Changes:
- adjusting the initialize method errors - see Getting Started for more details
3.15.0 - 16/10/20
Bug Fixes:
- fixing a bug where rounded corners were not displayed correctly in the story view
- fixing a bug on Android 8 where it was possible to see the story image as a background in the story view
Improvements:
- improving the preloading of stories in the story view
- improving the video cache
- improving the animation when a story is dismissed and returned to the row view
- improving the sensitivity of the swipe up gesture
3.14.1 - 09/10/20
Bug Fixes:
- fixing a bug where the instructions modal could be dismissed if the app was sent to the background when it was visible
- fixing a bug where it was possible for tiles in the row to render incorrectly in certain situations
Improvements:
- improving the error handling around the
initialize
flow to reduce the likelihood of any errors when this method is called
3.14.0 - 02/10/20
Bug Fixes:
- fixing a bug where it was possible for a user to be presented with a black screen with no loading indicator when opening the story view and on a slow connection
- fixing a bug where it was possible for a loading indicator not to be presented when viewing an image page in certain circumstances over a slow/unreliable network
Improvements:
- improving the handling of retries when assets in the story view fail to load
Deprecations and Changes:
- 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
- cancelling requests to preload content for the story view if the user is on a slow network connection in order to maximize the chance they are able to view the content they have on screen
3.13.1 - 29/09/20
Bug Fixes:
- fixing a bug where it was possible for tiles to appear blank in the story carousel
- removing a memory leak from within the SDK
- fixing a bug where if the
rowScale
for a row was changed while the row was being rendered, the story tiles could appear at the wrong size
- fixing a bug which could cause the SDK to crash in certain circumstances
- fixing a bug where it was possible to get stuck in the story view when skipping through a large number of stories and pages
- fixing a bug where it was possible for the story view to get stuck whilst dismissing
Improvements:
- improving the behavior of the SDK with respect to transitions when a non-translucent status bar is used for the activity where the row view is displayed
- improving the animation when a story is dismissed and returned to the row view
3.13.0 - 18/09/20
Bug Fixes:
- fixing a memory leak within the SDK
Improvements:
- further improvements to the transitions between tiles in the story row and the story view
New Features:
- adding full and intentional tablet support to the SDK
3.12.0 - 04/09/20
Improvements:
- improving email sharing by including the story title in any email sharing copy
- improving the reliability of directing users to the Play Store from a swipe up action
Deprecations and Changes:
- exposing Story Categories on the
getAdsForRow
callback - please see the Ads documentation for more details
3.11.0 - 24/08/20
Bug Fixes:
- fixing a bug where it was possible for an incorrect value to be passed for
openedReason
when a page completed
- fixing a bug where it was possible for
completedStory
events not to fire when a user completed a story
- fixing a bug where it was possible for an incorrect value to be passed to
dismissedReason
when a user completed the final page of the final story
Improvements:
- improving the open animation when a user taps a tile in the Story View
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
Deprecations and Changes:
- adjusting the initialization flow of the SDK - see Getting Started for more details
3.10.1 - 07/08/20
Bug Fixes:
- fixing a bug where stories were not marked as read until
reloadData
was called
- fixing a bug where it was possible for a story to be marked as unread when a page was removed from the story
- fixing a crash which could occur when retrieving or persisting encrypted data
- fixing a bug where it was possible for the Story View to open in landscape mode
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.9.0 - 31/07/20
Bug Fixes:
- fixing a bug where text was misaligned when using square tiles
- fixing a bug where it was possible to swipe twice on the final story and end up on a blank screen
Improvements:
- UI improvements to the Instructions Screen
- improving the reliability of the activity tracking
Deprecations and Changes:
3.8.3 - 27/07/20
New Features:
- adding
dismissStoryView
method to StorytellerRowView
to allow dismissing of any currently open Story View
3.8.0 - 15/07/20
Improvements:
- ensuring the user's device doesn't sleep when watching stories
- improving the experience when sharing via email
UI Changes:
- increasing the size of the tap target for the Swipe Up UI
3.7.4 - 14/07/20
Bug Fixes:
- fixing a bug where it was possible for a blank screen to be displayed when pushing the device back button on the instructions screen
- fixing a bug where it was possible for the story view to render at the size of a story tile
- fixing a bug where it was possible for
userSwipedUpToApp
to be triggered when navigating back to the Story View from the deeplink destination
3.7.3 - 10/07/20
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 crash when opening the Story View on Android 8
- fixing a bug where it was challenging to swipe up on stories
- fixing a bug where the dismiss animation from the stories row did not happen in some situations
- fixing a bug where it was possible for tracking pixels to be called multiple times in certain scenarios
3.7.1 - 07/07/20
Bug Fixes:
- fixing a bug where if the
StorytellerRowView
was within a RecyclerView
it was possible for there to be unexpected behavior when the view was recycled
Improvements:
- improving the performance of
setUserDetails
3.7.0 - 06/07/20
Bug Fixes:
- fixing a bug where the
adId
parameter was not present in certain scenarios for ad analytics events
Improvements:
- ensuring that
FinishedAd
also fires at the same time as PreviousAd
- UI improvements and bug fixes
New Features:
- adding the
advertiserName
parameter to ad analytics events
Deprecations and Changes:
- rewriting the transition from the Story Row to the Story View
3.6.0 - 01/07/20
Bug Fixes:
- fixing a bug where it was possible for Story events to fire for Ads
- fixing a bug where it was possible for the SDK to crash when rendering certain client supplied ads
- fixing a bug where it was possible for the SDK to crash when adding or removing pages to already published stories
Improvements:
- improving fault tolerance around network timeouts
- identifying and fixing 2 memory leaks within the SDK
Deprecations and Changes:
- exposing a new
FinishedAd
event which rolls up the DismissedAd
, SkippedAd
and ViewedAdPageComplete
events so it's easier to tell when an ad is not being presented to the user
3.5.2 - 20/06/20
- adding the ability to supply custom tracking pixels as part of the
getAdsForRow
request
- improving the interaction between the SDK and the status bar
- fixing a UI bug where the gradients in the loading tiles would not render correctly
- fixing a crash on Android 8
3.5.0 - 24/06/20
Bug Fixes:
- fixing a bug where it was possible for the close button and native back button to work if the Story View was triggered from landscape mode
- fixing a crash which could occur when swiping to particular stories
- fixing a bug where the Story View did not exit when a user finished watching all of their unread stories
- fixing a bug where single page stories were not being marked as read correctly
- fixing a crash which could occur when closing the Story View
Improvements:
- improved the loading performance of ads
UI Changes:
- UI improvements and bugfixes
3.4.0 - 17/06/20
Bug Fixes:
- fixing a crash which occurred when opening the Story View on Android 8
New Features:
- UI improvements and bugfixes
UI Changes:
- adding support for swiping up to the App Store or to a location within the integrating app from a page or an ad - see StorytellerRowViewDelegate for more details
3.3.0 - 11/06/20
Bug Fixes:
- fixing some bugs in the page navigation behavior around which pages are opened when stories are read/unread
- fixing a bug where it was possible for
durationViewed
to be 0.0
in situations where the user had viewed content
Improvements:
- improving the transitions when tapping a tile in the story row to open the Story View and when pulling down to dismiss the Story View
- improvements to preloading of stories to make swiping and tapping through the Story View feel much smoother
- 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
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
Deprecations and Changes:
- when calling
openPage
or openStory
, the onFailure
callback will be called if the ID passed to openPage
or openStory
doesn't match a valid story or page
- removing the
onSuccess
callback from openPage
and openStory
. If you would like to handle this case then please implement the onUserActivityOccurred
callback and listen for openedStory
or openedPage
events with an openedReason
of deeplink
3.2.0 - 03/06/20
Bug Fixes:
- fixing a bug where the
openedReason
analytics property could have an incorrect value when the user swiped between stories
Improvements:
- improving the rendering performance of the StoryRowView when using the square layout
3.1.0 - 28/05/20
Bug Fixes:
- fixing issue where
UserActivityData
class did not have publicly visible members
New Features:
- 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.0 - 20/05/20
New Features:
- (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
- 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