Storyteller SDK Documentation/com.storyteller.data/StorytellerClipsDataModel

StorytellerClipsDataModel

data class StorytellerClipsDataModel(val collection: String, 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 Clips from a specific collection. For more details on configuring Storyteller lists, see the Storyteller Lists Documentation.

Constructors

constructor(collection: String, 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

cellType

open override val cellType: StorytellerListViewCellType

The StorytellerListViewCellType for the Clip items.

collection

val collection: String

The ID of the Clips collection to display. This is mandatory; if blank, the model is isValid false.

context

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.

displayLimit

open override val displayLimit: Int

The maximum number of Clips 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.

isValid

open override val isValid: Boolean

A StorytellerClipsDataModel is valid if the collection ID is not blank.

offset

open override val offset: Int = 0

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

theme

open override val theme: UiTheme? = null

Optional UiTheme to customize the appearance of this specific list.

uiStyle

open override val uiStyle: StorytellerListViewStyle

The StorytellerListViewStyle for this list.

visibleTiles

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.