Storyly Event Handling

This guide shows you how to handle Storyly events in your app. Storyly events provide insight on what is happening on a Storyly instance such as loading states, user redirections, user interaction.

Before you begin

You need to have the working Storyly integration as described in Initial SDK Setup

Set up Listener

StorylyView notifies application when an event occurs. You can register the listener using the following code example and then override its functions to learn about specific events, which will be explained in the next sections.

storyly_view.storylyListener = object : StorylyListener {
    // Override event functions
}

storyly_view.setStorylyListener(new StorylyListener() {
    // Override event methods
});

Basic Storyly Functionality Events

This section shows you how to observe Storyly's basic functionality events. In order to get notification about these basic events, you should override the following functions in StorylyListener, which you have registered in the previous section.

---

StorylyLoaded Event

This event will let you know that Storyly has completed its data operations, and the story group list has just been shown to the user. In addition to list of story groups, data source of the these groups is provided. In order to notified about this event, use the following example:

override fun storylyLoaded(storylyView: StorylyView, 
                           storyGroupList: List<StoryGroup>,
                           dataSource: StorylyDataSource) {}

@Override
public void storylyLoaded(@NonNull StorylyView storylyView, 
                          @NonNull List<StoryGroup> storyGroupList,
                          @NonNull StorylyDataSource dataSource) {}

WARNING

dataSource parameter is added in v1.18.0 version and older signature of storylyLoaded became obsolete. Users who will update their Storyly version to v1.18.0 or later must change storylyLoaded signature.

StorylyLoadFailed Event

This event will let you know that Storyly has completed its network operations and had a problem while fetching your stories. In this case, users will see four empty story group icons, which we call skeleton view. In order to notified about this event, use the following example:

override fun storylyLoadFailed(storylyView: StorylyView, 
                               errorMessage: String) {}

@Override
public void storylyLoadFailed(@NonNull StorylyView storylyView, 
                              @NonNull String errorMessage) {}

StorylyStoryShowFailed Event

This event will let you know that Storyly could not open Story programmatically and had a problem about parameters (Story Groupd ID, Story ID or Play Mode). In this case, users will still able to see story group icons with data. In order to notified about this event, use the following example:

override fun storylyStoryShowFailed(storylyView: StorylyView, 
                                    errorMessage: String) {}

@Override
public void storylyStoryShowFailed(@NonNull StorylyView storylyView, 
                                   @NonNull String errorMessage) {}

StorylyStoryShown Event

This event will let you know that stories are starting to be shown to the users. In order to notified about this event, use the following example:

override fun storylyStoryShown(storylyView: StorylyView) {}

@Override
public void storylyStoryShown(@NonNull StorylyView storylyView) {}

StorylyStoryDismissed Event

This event will let you know that the user dismissed the current story while watching it. In order to notified about this event, use the following example:

override fun storylyStoryDismissed(storylyView: StorylyView) {}

@Override
public void storylyStoryDismissed(@NonNull StorylyView storylyView) {}

Button Click & Swipe Up Events

This section shows you how to handle swipe up and action button clicks from users.

---

Storyly content is designed to redirect users to the application’s content more effectively. For this purpose, we’ve Call to Action flow. You can add Swipe Up or CTA Button to any story using Storyly Studio, and you will have access to any information about the action with this flow. Storyly will notify your application in case of Swipe Up or CTA Button action. In order to get these notifications, you should override the following function in StorylyListener, which you have registered in the previous section.

override fun storylyActionClicked(
    storylyView: StorylyView,
    story: Story
) {
    // story.media.actionUrl is important field
}

@Override
public void storylyActionClicked(@NonNull StorylyView storylyView,
                                    @NonNull Story story) {
    // story.media.actionUrl is important field
}

Interactive Events with Tracking ID

This guide shows you how to get reactions of users from specific interactive components. You can use the following function to get reactions of your users:

override fun storylyUserInteracted(storylyView: StorylyView,
                                   storyGroup: StoryGroup,
                                   story: Story,
                                   storyComponent: StoryComponent) {}

@Override
public void storylyUserInteracted(@NonNull StorylyView storylyView,
                                  @NonNull StoryGroup storyGroup,
                                  @NonNull Story story,
                                  @NonNull StoryComponent storyComponent) {}

StoryComponent parameter informs your application about the interacted component and the details of the interaction. For instance, if a user answers a quiz, the payload will include what the right answer is and what the user's answer is. The structure of StoryComponent is different for each of the interactive components.

WARNING

This event only notifies your application about Emoji, Rating, Poll, Quiz, and Countdown reactions.

Tracking ID

From Storyly Studio, application owners can give tracking ids to the interactive components. This id can be received using the customPayload field of StoryComponent.

Sending Events to Analytics/Data Platforms

This guide shows you how to send the Storyly events to specific data platforms. You can use the following function to redirect the Storyly events to your data platform:

override fun storylyEvent(storylyView: StorylyView, event: StorylyEvent,
                          storyGroup: StoryGroup?, story: Story?,
                          storyComponent: StoryComponent?) {}

 @Override
public void storylyEvent(@NonNull StorylyView storylyView, @NonNull StorylyEvent storylyEvent,
                         @Nullable StoryGroup storyGroup, @Nullable Story story,
                         @Nullable StoryComponent storyComponent) {}

Tip

You can also check Storyly Events (opens new window)