These are the various events which are triggered from within the SDK. These events are passed to the onUserActivityOccurred
delegate method. Please see the StorytellerListViewDelegate page for details on implementing delegate methods.
This event is recorded in the following scenarios:
This event is recorded when as soon as a user sees content for a Page
This event is recorded in the following scenarios:
This event is recorded when:
This event is recorded at the same time as OpenedPage
for the final Page in a Story.
This event is recorded in the following scenarios:
This event is recorded when a user taps the share button on a Page
This event is recorded when:
This event is recorded when a user taps back to go to a previous Page in the Story
Voted Poll
This event is recorded when a user votes for a Poll answer
For each event, data is returned with details about the Story and Page involved as well as some extra properties with more information about what the user has done. The data is returned as a UserActivityData
class with the following properties:
storyId: String?
- the ID of the Story for which the event occurredstoryTitle: String?
- the title of the Story for which the event occurredstoryIndex: Int?
- the index of the Story for which the event occurred in the row from which it was opened at the point it was opened - this is only included on openedStory
events. Note: this value is 1-basedstoryPageCount: Int?
- the number of Pages in the StorystoryReadStatus: String?
- whether the Story was read or unread at the point the Story was opened - this is only included on openedStory
events. Note this will either be read
or unread
.pageId: String?
- the ID of the Page for which the event occurredpageIndex: Int?
- the index of the Page in the Story for which the event occurred. Note: this value is 1-basedpageType: String?
- the type of the Page associated with the event. This can have the value image
, video
or poll
pageHasSwipeUp: Bool?
- whether the Page associated with the event contains a swipe up linkpageSwipeUpText: String?
- if the Page associated with the event has a swipe up link, the text call to action associated with that linkpageSwipeUpUrl: String?
- if the Page associated with the event has a swipe up link, the URL which is linked to from the swipe upopenedReason: String?
- only included on openedStory
events. Possible values are storyRowTap
(the user tapped the Story in the Story row to open the Story); deepLink
(the user navigated directly to the Story URL); swipe
(the user swiped left or right to change the current Story); navigation
(either the user tapped to open the next/previous Page, or the Page finished playing and the next Page was shown)dismissedReason: String?
- only included on dismissedStory
events - possible values are closeButtonTapped
(the user tapped close to dismiss the Story); swipedDown
(the user swiped down to dismiss the Story); navigatedFinalPage
(the user either completed or skipped the final Page of a Story); swipedFirstStory
(the user swiped right on the first Story); swipedFinalStory
(the user swiped right on the final Story);durationViewed: Float?
- In milliseconds, the duration the user viewed the Story view for (measured from the most recent openedStory
event with an Opened Reason of storyRowTap
or deepLink
). This timer is reset after any dismissedStory
eventspagesViewedCount: Int?
- the total number of Pages a user has viewed since the most recent openedStory
event with an Opened Reason of storyRowTap
or deepLink
. This count is reset after any dismissedStory
eventscontentLength: Int?
- in seconds, the total duration of the Page contentcategories
- only included on openedStory
events. List of categories assigned to the Story for which the event occurred.pollAnswerId
- only included on votedPoll
events. ID of the Poll answer voted for by the user.