Storyteller SDK Documentation/com.storyteller.data/StorytellerStoriesDataModel

StorytellerStoriesDataModel

data class StorytellerStoriesDataModel(val categories: List<String>? = null, val theme: UiTheme? = null, val uiStyle: StorytellerListViewStyle = StorytellerListViewStyle.AUTO, val displayLimit: Int = Int.MAX_VALUE, val cellType: StorytellerListViewCellType = StorytellerListViewCellType.SQUARE, val offset: Int = 0, val visibleTiles: Float? = null, val context: StorytellerAnalyticsContext? = null) : StorytellerDataModel

Data model for displaying a list of Stories based on categories. For more details on configuring Storyteller lists, see the Storyteller Lists Documentation.

Constructors

StorytellerStoriesDataModel

constructor(categories: List<String>? = null, theme: UiTheme? = null, uiStyle: StorytellerListViewStyle = StorytellerListViewStyle.AUTO, displayLimit: Int = Int.MAX_VALUE, cellType: StorytellerListViewCellType = StorytellerListViewCellType.SQUARE, offset: Int = 0, visibleTiles: Float? = null, context: StorytellerAnalyticsContext? = null)

Properties

val categories: List<String>? = null

A list of category IDs to fetch Stories from. If null, the model is considered isValid false.

open override val cellType: StorytellerListViewCellType

The StorytellerListViewCellType for the Story items.

open override 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.

open override val displayLimit: Int

The maximum number of Stories to display.

open override val id: String

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

open override val isValid: Boolean

A StorytellerStoriesDataModel is valid if categories is not null.

open override val offset: Int = 0

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

open override val theme: UiTheme? = null

Optional UiTheme to customize the appearance of this specific list.

open override val uiStyle: StorytellerListViewStyle

The StorytellerListViewStyle for this list.

open override 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.