Developers / Android SDK / Changelog

Changelog

7.1.0

adding support for Live Stories
adding additional attributes to support Live Stories theming - please see Themes for details
fixing an issue with the instructions screen UI
improving UI/UX experience in Story Player

7.0.3

fixing a dependency clash with Koin library

7.0.2

fixing an issue with ReactNative

7.0.1

fixing an issues with quizzes and theme colors
fixing an issue where the UiTheme had obfuscated name

7.0.0

adding support for Trivia Quizzes
making it easier to define a custom theme - please see Themes for details
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

6.2.0

improved support for multiple StoryListViews inside a RecyclerView

6.1.4

fixing an issue with the navigation for the video pages on Android 12

6.1.3

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

fixing obfuscation issues

6.1.1

improving the story tile resizing
fixing an issue with the reloading of the stories list
fixing an issue with the story tiles flickering when reloading
pagesViewedCount is public again

6.1.0

fixing an issue with navigation which could occur when ads are enabled
uiStyle parameter moved to StorytellerListView (see here for more details StorytellerListView.md
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

6.0.2

fixing obfuscation issues

6.0.1

improving the poll UI
improving the UI on the devices with notch
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

6.0.0

Added StorytellerGridView (see here for more details StorytellerGridView)
Adding the ability to override the theme on a per list basis
Improving the scaling behavior of story tiles
Improvements and bugfixes in how themes are handled
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

fix for race conditions in case of rapid onPause/onResume scenarios

5.0.7

fixing a potential issue which could occur when running unit tests with Storyteller

5.0.6

fixing dependency issues

5.0.5

fixing a concurrency issue

5.0.4

fixing a crash which could occur when skipping through the pages fast

5.0.3

fixing a crash which could occur when invoking Storyteller.initialize multiple times

5.0.2

fixing a bug with the user activity data parsing
removing all jcenter() dependencies

5.0.1

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

adding support for categories - please see StorytellerRowView for details
splitting StorytellerRowViewDelegate into two separate delegates - please see StorytellerDelegate and StorytellerRowViewDelegate for details
adding support for opening the story player in single story mode without the StorytellerRowView - please see AdditionalMethods for details
removing the cellScale parameter from the StorytellerRowView in favour of auto adapting to the parent's view height
adding additional param storyPlaybackMode to analytics events - please see Analytics for details
removing callbacks from the reloadData() method
improving sending of analytics events

4.5.11

fixing a crash which could occur when sharing the story on Android 12

4.5.10

adding additional method configureSwipeUpWebView(webview: Webview, url : String?, favicon: Bitmap?) to allow additional configuration of the WebView - please see StorytellerRowViewDelegate

4.5.9

fixing a crash which could occur when opening the story and scrolling the row in a container

4.5.8

fixing a problem with ads and navigation
fixing a UI issue with the rounded corners on tablets

4.5.7

fixing a potential clash with resource names
fixing a crash which could occur when using a malformed swipe up url

4.5.6

fixing Windows build issue originating in the kotlinModule compilation artifact containing characters disallowed in windows filesystem

4.5.5

fixing a bug where the swipe up to in_app links was not working
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

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
deep linking documentation update - please see Deep Linking

4.5.3

fixing a packaging issue

4.5.2

adding additional method isStorytellerDeepLink(String) to make Storyteller SDK integration easier - please see AdditionalMethods
fixing a bug where the poll answers could be cut on some devices

4.5.1

fixing a tablet bug where the story player could be frozen when changing orientation

4.5.0

minor performance improvements

4.4.2

improving the story tile loading states
fixing a bug where the COMPLETED_STORY event could be triggered too early

4.4.1

add animated parameter for openPage and openStory public methods
improve in app swipe up handling

4.4.0

resources can be used to set the theme properties - please see Themes for details
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

4.3.3

fixing a crash which could occur during the preload of images

4.3.2

added another fix for crash caused by connection timeouts
fixing a bug where the swipe ups were sometimes not working

4.3.1

added a fix for crash caused by connection timeouts

4.3.0

fixing a crash which could occur when using custom ads
fixing a bug where the poll answers could start flickering
improving the page loading states

4.2.0

adding support for themes - please see Themes for details
internalizing the Exoplayer 2.14.0 to remove any version conflicts with the client applications
adding additional methods to make Storyteller SDK integration easier - please see AdditionalMethods

4.1.3

improved poll UI and animations
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

4.1.2

improved poll UI and animations
fixed an issue with tile animation being clipped
extended the page duration when a user selects poll answer

4.1.1

fixing a bug where the navigation on poll pages could stop working
improving the network request format

4.1.0

improving the poll UI
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

4.0.5

fixing a crash which could occur when opening a story
improving the animation when swiping between stories for Android 11 devices

4.0.4

fixing a crash which could occur when opening a story from a deep link

4.0.3

improving the preloading of videos on poll pages
improving sharing to different apps

4.0.2

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

adding support for video backgrounds on poll pages
fixing some visual bugs which could occur on the poll pages
fixing a crash which could occur when closing the story view

4.0.0

adding support for poll pages
adding support for multiple instances of the Story Row in a single app
changing the method signatures of openStory, openPage and reloadData - see StorytellerRowView for more details
performance improvements for video and image pages
fixing a bug where it was possible for swipe ups to stop working
fixing a crash which could occur when saving analytics data

3.17.5

fixing a bug where the in-app browser address bar could be white in night mode

3.17.4

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

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

fixing a crash which could occur when preloading videos for stories

3.17.0

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

fixing a bug where the blank page was opened instead of a story

3.16.3

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

fixing a bug introduced in 3.16.0 where it was possible for incorrect tracking pixels to be called for integrating app ads
not sending extra parameters to tracking pixels supplied via integrating app ads
improving video preloading with the new version of Exoplayer

3.16.1

fixing a crash which could occur when swiping to interact with the Story View

3.16.0

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
improving the performance of the story view when quickly transitioning between pages
adding video playback events - please see Analytics for details

3.15.5

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

fixing a crash which could occur when swiping to interact with the Story View

3.15.3

fixing a crash which could occur when swiping to interact with the Story View

3.15.2

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

adjusting the initialize method errors - see Getting Started for more details
improving the smartphone onboarding layout
improving the animation when story is opened
improving the preloading of videos

3.15.0

fixing a bug where rounded corners were not displayed correctly in the story view
improving the preloading of stories in the story view
improving the video cache
fixing a bug on Android 8 where it was possible to see the story image as a background in the story view
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

fixing a bug where the instructions modal could be dismissed if the app was backgrounded when it was visible
fixing a bug where it was possible for tiles in the row to render incorrectly in certain situations
improving the error handling around the initialize flow to reduce the likelihood of any errors when this method is called

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
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
improving the handling of retries when assets in the story view fail to load
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

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
fixing a bug where it was possible for tiles to appear blank in the story carousel
removing a memory leak from within the SDK
improving the animation when a story is dismissed and returned to the row view
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

3.13.0

adding full and intentional tablet support to the SDK
fixing a memory leak within the SDK
further improvements to the transitions between tiles in the story row and the story view

3.12.0

improving email sharing by including the story title in any email sharing copy
exposing Story Categories on the getAdsForRow callback - please see the Ads documentation for more details
improving the reliability of directing users to the Play Store from a swipe up action

3.11.0

improving the open animation when a user taps a tile in the Story View
adjusting the initialization flow of the SDK - see Getting Started for more details
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
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.1

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
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

UI improvements to the Instructions Screen
improving the reliability of the activity tracking
fixing a bug where text was misaligned when using square tiles
adjusting the StorytellerRowViewDelegate getAdsForRow callback to allow it to accept null values for ClientAd
fixing a bug where it was possible to swipe twice on the final story and end up on a blank screen

3.8.3

adding dismissStoryView method to StorytellerRowView to allow dismissing of any currently open Story View

3.8.0

ensuring the user's device doesn't sleep when watching stories
increasing the size of the tap target for the Swipe Up UI
improving the experience when sharing via email

3.7.4

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

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

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

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
improving the performance of setUserDetails

3.7.0

ensuring that FinishedAd also fires at the same time as PreviousAd
UI improvements and bug fixes
adding the advertiserName parameter to ad analytics events
rewriting the transition from the Story Row to the Story View
fixing a bug where the adId parameter was not present in certain scenarios for ad analytics events

3.6.0

improving fault tolerance around network timeouts
identifying and fixing 2 memory leaks within the SDK
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
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

3.5.2

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

improved the loading performance of ads
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
UI improvements and bugfixes
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

3.4.0

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
UI improvements and bugfixes
fixing a crash which occurred when opening the Story View on Android 8

3.3.0

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
adding a ShareSuccess event to the SDK
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
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
fixing a bug where it was possible for durationViewed to be 0.0 in situations where the user had viewed content

3.2.0

fixing a bug where the openedReason analytics property could have an incorrect value when the user swiped between stories
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
fixing issue where UserActivityData class 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
(beta) adding onUserActivityOccurred callback to StorytellerRowViewDelegate so the containing app can receive notifications when users take actions within the SDK

Additional Methods Forward Arrow