These are the various events which are triggered from within the SDK. Each event is a member of the EventType
enumeration. Please see the StorytellerListComponent page for details on how to bind to these events.
In the below discussion, "completing" a Page refers to allowing the timer to expire - so this would correspond to watching all of an image Page for the duration set for it (default 15s) or watching all of a video.
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 when a user taps to go to the next Page before completing the current Page
This event is recorded at the same time as OpenedPage
for the final Page in a Story.
This event is recorded when a user watches a Page to completion (i.e. the timer for that Page finishes)
This event is recorded when a user taps on an action button on a Page to open a link.
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
This event is recorded when a user:
This event is recorded when user votes in a Poll.
This event is recorded when a user submits a Quiz answer.
This event is recorded when a user completes a Quiz.
This event is recorded when:
This event is recorded when a user:
This event is recorded when a user:
This event is recorded when a user:
This event is recorded when a user:
This event is recorded at the same time as Dismissed Ad, Skipped Ad, Previous Ad and Viewed Ad Page Complete and gives an easier way to determine when an ad finishes for any reason.
This event is recorded when a user pauses a Page within an ad by pressing and holding on the Page
This event is recorded when a user resumes playing a Page within an ad by releasing their long press which paused the ad
This event is recorded when a user reaches 1/4 of the way through the duration of a Page which is within an ad
This event is recorded when a user reaches halfway through the duration of a Page which is within an ad
This event is recorded when a user reaches 3/4 of the way through the duration of a Page which is within an ad
This event is recorded when a user reaches the end of the duration for a Page which is within an ad
This event is called once per video Page at the point when the video player has been loaded
This event is called once per video Page at the point when the video starts to play for the first time
This event is called on video Pages whenever the video starts to buffer
This event is called on video Pages whenever the video finishes buffering
Note: There should be at most one Ready to Play event and one Media Started event for every Page. There may be multiple Buffering Started/Buffering Ended pairs of events for an individual Page. There may not always be a Buffering Ended event for every Buffering Started event as the user may choose to exit the Page during buffering.
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:? number
- 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?: number
- 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?: number
- 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
pageHasAction:? boolean
- whether the page associated with the event contains an action linkpageActionText?: string
- if the page associated with the event has an action link, the text call to action associated with that linkpageActionUrl?: string
- if the page associated with the event has an action link, the URL which is linked to from the actionopenedReason?: string
- only included on OpenedStory
events. Possible values are storyRowTap
(the user tapped the story in the story row to open the story); deepLink
(openDeepLink was called to open the story); swipe
(the user swiped left or right to change the current story); automaticPlayback
(the user completed the previous page - that is, the timer for that page completes); tap
(the user tapped on the previous page to navigate to this page)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); swipedFirstStory
(the user swiped the first story to dismiss it); swipedFinalStory
(the user swiped the final story to dismiss it); skippedFinalPage
(the user tapped to skip the final page of the final story); completedFinalPage
(the user completed the final page of the final story); backTapped
(the user tapped their device back button to dismiss the story view (Android only))durationViewed?: number
- 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?: number
- 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?: number
- In seconds, the total duration of the Page contentadId?: string
- if the event is associated with an ad, then the ID of that adshareMethod:? string
- component name of the app which the user has selected for sharingadvertiserName?: string
- the name of the advertiser for a particular ad. This is only included for ad eventsisInitialBuffering?: boolean
- returned if the buffering happens at the start of playback for that Page. Ths is only included for BufferingStarted
and BufferingEnded
eventstimeSinceBufferingBegan?: number
- in milliseconds, the duration which the current buffering lasted for. This is only included for BufferingEnded
eventscategories?: Array<String>
- only included on OpenedStory
events. List of categories assigned to the Story for which the event occurred.pollAnswerId?: string
- only included on VotedPoll
events. The ID of the answer which was selected by the user when voting.triviaQuizAnswerId?: string
- only included in TriviaQuizQuestionAnswered
event. The ID of the answer which was selected by the user.triviaQuizId?: string
- included for Quiz Page Events. The ID of the Quiz.triviaQuizQuestionId?: string
- included for Quiz Page Events. The question ID of the Quiz Page.triviaQuizTitle?: string
- included for Quiz Page Events. The title of the Quiz PagetriviaQuizScore?: number
- only included in TriviaQuizCompleted
event. The result obtained by the user.