StorytellerDelegate

A StorytellerDelegate has methods for managing Storyteller events. It is used as global object for handling all events when opening a story player with and without the StorytellerRowView or StorytellerGridView. Please see the dedicated StorytellerListViewDelegate for handling events related to rows and grids.

How To Use

To use global StorytellerDelegate, implement the StorytellerDelegate interface by overriding the required methods and set it in Storyteller object.

• onUserActivityOccurred(type: UserActivity.EventType, data: UserActivityData) - Called when an analytics event is triggered
• getAdsForList(stories: List<ClientStory>, onComplete: (AdResponse) -> Unit) - Called when the tenant is configured to request ads from the containing app and the SDK requires ad data from the containing app
• userSwipedUpToApp(swipeUpUrl: String) - Called when a user swipes up on a page which should direct the user to a specific place within the integrating app
• configureSwipeUpWebView(webview: Webview, url : String?, favicon: Bitmap?) - Called when a page is swiped up for web links and the WebView starts to load the page. This callback can be used to inject an arbitrary javascript into WebView or to change WebView settings. Note following:
  • this action will be fired for every visited url - even for those followed by link click
  • webview param is connected to the parent activity, so extra care should be taken when modifying its configuration. In particular activity expect to receive notifications through WebChromeClient and WebViewClient interfaces attached to the WebView

Example:

    Storyteller.storytellerDelegate = myCustomStorytellerDelegate

Analytics

The callback onUserActivityOccurred provides analytics events and corresponding data triggered internally by the SDK. This information can be used in your app.

The following parameters are passed to the callback method:

• type - type of event that occurred, as a UserActivity.EventType enum
• data - an object containing data about the event which occurred

Example:

    ...
    override fun onUserActivityOccurred(type: UserActivity.EventType, data: UserActivityData) {
        if (type == UserActivity.EventType.OPENED_STORY) {
            // Retrieve the story id value
            val openStoryId = data.storyId
            // Retrieve the story title value
            val openStoryTitle = data.storyTitle

            // Report retrieved values from your app
        }
    }

For a detailed discussion of all the relevant events and properties please see the dedicated Analytics page.

Client Ads

By implementing getAdsForList, you can provide custom ad data for the SDK to render, this is only applicable when the ad configuration is set to Integrating App in the CMS. Ad data can be obtained asynchronously, and should be provided using the onComplete closure parameter.

Example:

    ...
    override fun getAdsForList(stories: List<ClientStory>, onComplete: (AdResponse) -> Unit) {
        // Action to get some ads
        val ads = getMyAds()
        // Provide the ads to the SDK
        onComplete(ads)
    }

For a detailed discussion of all the relevant considerations, please see the dedicated Ads page.

Swiping Up To The Integrating App

The callback userSwipedUpToApp is called when a user swipes up on a page which has its link type set to In App. In this case, your app will be passed a swipe up URL which has been entered in the Storyteller CMS and your app is then responsible for parsing this URL and following it to the correct location within your app.

Example:

    override fun userSwipedUpToApp(swipeUpUrl: String) {
        // parse the swipeUpUrl and navigate to the destination
    }