Storyteller SDK Documentation/com.storyteller.ui.list/StorytellerClipsView/ListConfiguration

ListConfiguration

data class ListConfiguration(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 context: StorytellerAnalyticsContext? = null, val collection: String) : StorytellerListView.StorytellerListConfiguration

Data class for configuring a StorytellerClipsView (e.g., StorytellerClipsRowView, StorytellerClipsGridView). It defines the specific collection of Clips to display and visual properties like theme, style, and cell type.

Constructors

ListConfiguration

constructor(theme: UiTheme? = null, uiStyle: StorytellerListViewStyle = StorytellerListViewStyle.AUTO, displayLimit: Int = Int.MAX_VALUE, cellType: StorytellerListViewCellType = StorytellerListViewCellType.SQUARE, offset: Int = 0, context: StorytellerAnalyticsContext? = null, collection: String)

Properties

cellType

open override val cellType: StorytellerListViewCellType

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

collection

val collection: String

The ID of the Clips collection to be displayed. This is a mandatory parameter for showing Clips.

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 in the list. Defaults to Int.MAX_VALUE (no limit).

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. If null, the global theme or default SDK theme will be used.

uiStyle

open override val uiStyle: StorytellerListViewStyle

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