Companion
Gets on private val are critical as they deffer resolution
Properties
Gets the current API environment the SDK is configured to use. This is typically set internally during initialization or can be overridden for testing purposes.
Enables or disables verbose logging from the Storyteller SDK. Default is false. See also Additional SDK Methods.
Gets the current event tracking options. These options are set during SDK initialization and cannot be modified afterwards. For details on privacy and tracking options, see the Storyteller Privacy and Tracking Documentation.
Indicates whether the Storyteller SDK has been successfully initialized. This becomes true after a successful call to initialize.
Indicates whether the Storyteller player UI is currently visible on screen. This is managed internally by the SDK.
Indicates whether the search functionality is enabled for the current API key. This is determined by the settings fetched from the Storyteller backend.
A delegate for handling various events and actions within the Storyteller SDK. This allows the client application to customize behavior or react to SDK events. See StorytellerDelegate for the available callback methods.
A lambda function that allows overriding the default behavior for opening a category. If this lambda returns true for a given StorytellerCategory, the SDK will not handle the category opening, allowing the client application to implement custom navigation or UI for specific categories. Default implementation always returns false.
Provides access to user attributes stored by the SDK.
Functions
Dismisses the currently visible Storyteller player. For more information on this and other utility methods, see Additional SDK Methods.
Retrieves the count of clips for the specified categories.
Retrieves the count of stories for the specified categories.
Initializes the Storyteller SDK with the provided API key and optional user input. This method should be called once, typically in your Application's onCreate method. Initialization is asynchronous. The onSuccess callback is invoked upon successful initialization, and onFailure is invoked if an error occurs. For details on providing user information, see the Storyteller User Management Documentation. For a general guide on SDK setup, refer to the Getting Started Guide.
Checks if the given string is a valid Storyteller deep link. This includes deep links for Stories, Clips collections, categories, or sheets. For more information on deep linking, see the Storyteller Deep Linking Documentation.
Opens a specific category of Stories. Optionally, a specific Story within that category can be targeted.
Opens a collection of Clips using a StorytellerClipCollectionConfiguration. This allows specifying the collection ID, an optional category ID, and an optional starting Clip ID.
Opens a collection of Clips by its ID, optionally starting with a Clip identified by its external ID. For more details on opening the Storyteller player, see the Opening the Player Documentation.
Opens content based on a Storyteller deep link. This method can handle deep links for Stories, Clips collections, categories, or sheets. For more information on deep linking, see the Storyteller Deep Linking Documentation.
Opens a specific Page within a Story by its ID.
Opens the Storyteller search interface. This method will only work if search is enabled for your API key. Check isSearchEnabled.
Opens a Storyteller Sheet (a bottom sheet UI component) by its ID. For more information on this and other utility methods, see Additional SDK Methods.
Opens a specific Story by its ID.
Opens a Story by its external ID. External IDs are alternative identifiers that can be assigned to Stories in the Storyteller CMS.
Preloads a Clips collection and optional single Clip IDs into the in-memory cache.
Resumes playback if a Storyteller player is active and paused. For more information on this and other utility methods, see Additional SDK Methods.