StorytellerDataModel

Base class for data models used to configure Storyteller list views. It defines common properties for displaying Stories or Clips. For more details on configuring Storyteller lists, see the Storyteller Lists Documentation.

Inheritors

Properties

Link copied to clipboard

The StorytellerListViewCellType for the items in the list (e.g., SQUARE, ROUND). Defaults to SQUARE.

Link copied to clipboard

Optional StorytellerAnalyticsContext containing integrator-defined key-value pairs for analytics attribution. This context will be included with all analytics events originating from this UI instance. It is never sent to the Storyteller API.

Link copied to clipboard
open val displayLimit: Int

The maximum number of items to display in the list. Defaults to Int.MAX_VALUE (no limit).

Link copied to clipboard
abstract val id: String

A unique identifier for this specific data model instance. It's a combination of the key and an internal uuid.

Link copied to clipboard
abstract val isValid: Boolean

Indicates whether the data model configuration is valid and can be used to load content. For example, StorytellerStoriesDataModel is invalid if categories is null. StorytellerClipsDataModel is invalid if collection is blank.

Link copied to clipboard
open val theme: UiTheme? = null

Optional UiTheme to customize the appearance of the list. If null, the global theme or default SDK theme will be used.

Link copied to clipboard

The StorytellerListViewStyle to be applied (e.g., LIGHT, DARK). Defaults to AUTO.

Link copied to clipboard
open val visibleTiles: Float? = null

Optional number of tiles that should be visible on screen for row layouts. For example, a value of 2.5f would show two full tiles and half of a third tile. The actual row height will be calculated based on this value and the device's default font size. If the user has changed their font scale significantly, the layout will automatically adapt for better accessibility.