Storyteller SDK Documentation/com.storyteller/Storyteller

Storyteller

The main entry point for interacting with the Storyteller SDK. This class provides methods for initializing the SDK, opening Stories and Clips, handling deep links, managing user information, and configuring various SDK features. For an overview of how to integrate and use the SDK, see the Getting Started Guide.

It is recommended to initialize the SDK in your Application's onCreate method.

Types

Companion

object Companion

Gets on private val are critical as they deffer resolution

StorytellerClipCollectionConfiguration

data class StorytellerClipCollectionConfiguration(val collectionId: String, val categoryId: String? = null, val clipId: String? = null, val offset: Int? = null, val context: StorytellerAnalyticsContext? = null)

Configuration for opening a collection of Clips. For more details on opening the Storyteller player, see the Opening the Player Documentation.

StorytellerClipsOpenReason

enum StorytellerClipsOpenReason : Enum<Storyteller.StorytellerClipsOpenReason>

Specifies the reason why a Clips collection was opened, typically used for analytics. For more details on opening the Storyteller player, see the Opening the Player Documentation.

StorytellerEventTrackingOptions

data class StorytellerEventTrackingOptions(val enablePersonalization: Boolean = true, val enableStorytellerTracking: Boolean = true, val enableUserActivityTracking: Boolean = true, val enableAdTracking: Boolean = true, val enableFullVideoAnalytics: Boolean = true, val enableRemoteViewingStore: Boolean = true, val disabledFunctionalFeatures: List<StorytellerDisabledFunctionalFeature> = emptyList())

Configuration options for event tracking within the Storyteller SDK. For details on privacy and tracking options, see the Storyteller Privacy and Tracking Documentation.

StorytellerStoriesOpenReason

enum StorytellerStoriesOpenReason : Enum<Storyteller.StorytellerStoriesOpenReason>