Storyteller SDK Documentation/com.storyteller.data/StorytellerDataModel

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

StorytellerStoriesDataModel

StorytellerClipsDataModel

Properties

cellType

open val cellType: StorytellerListViewCellType

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

context

open val context: StorytellerAnalyticsContext? = null

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.

displayLimit

open val displayLimit: Int

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

abstract val id: String

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

isValid

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.

offset

open val offset: Int = 0

The offset to start displaying items from a specific position in the collection. Default is 0 (start from beginning).

theme

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.

uiStyle

open val uiStyle: StorytellerListViewStyle

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

visibleTiles

open val visibleTiles: Float? = null

Only use it in case of special need. This should generally remain unset. Specifies the number of tiles that should be visible on screen at any given time for row layouts. For example, a value of 2.5f would mean two full tiles and half of a third tile are visible.