Package com.appsamurai.storyly

Types

BaseInit

abstract class BaseInit(storylyId: String, config: STRConfig)

PlayMode

enum PlayMode : Enum<PlayMode>

This data class represents the preview mode of stories.

ShareType

enum ShareType : Enum<ShareType>

Story

data class Story(uniqueId: String, index: Int, title: String, name: String?, seen: Boolean, currentTime: Long?, previewUrl: String?, storyComponentList: List<StoryComponent>?, actionUrl: String?, actionProducts: List<STRProductItem>?)

This data class represents a story inside a story group.

StoryButtonComponent

data class StoryButtonComponent(id: String, text: String, actionUrl: String?, products: List<STRProductItem>?, customPayload: String?) : StoryComponent

This data class represents the ButtonAction component.

StoryCommentComponent

data class StoryCommentComponent(id: String, text: String, customPayload: String?) : StoryComponent

This data class represents the Comment component.

StoryComponent

open class StoryComponent(id: String, type: StoryComponentType, customPayload: String?)

This parent class represents the interactive components which users are interacted with.

StoryComponentType

enum StoryComponentType : Enum<StoryComponentType>

This enum class represents the type of the components.

StoryEmojiComponent

data class StoryEmojiComponent(id: String, emojiCodes: List<String>, selectedEmojiIndex: Int, customPayload: String?) : StoryComponent

This data class represents the Emoji component.

StoryGroup

data class StoryGroup(uniqueId: String, title: String, iconUrl: String?, iconVideoUrl: String?, iconVideoThumbnailUrl: String?, index: Int, seen: Boolean, stories: List<Story>, pinned: Boolean, type: StoryGroupType, style: StoryGroupStyle?, name: String?, nudge: Boolean)

This data class represents a story group in the StorylyView.

StoryGroupAnimation

enum StoryGroupAnimation : Enum<StoryGroupAnimation>

This enum class represents available animations that can be set for customization.

StoryGroupBadgeStyle

data class StoryGroupBadgeStyle(text: String?, @ColorInt textColor: Int?, @ColorInt backgroundColor: Int?, endTime: Long?, template: String?)

This class represents a story group's badge style in the StorylyView.

StoryGroupListOrientation

enum StoryGroupListOrientation : Enum<StoryGroupListOrientation>

This enum class represents orientation of story group list

StoryGroupSize

enum StoryGroupSize : Enum<StoryGroupSize>

This enum class represents available story group sizes that be can set for customization

StoryGroupStyle

data class StoryGroupStyle(@ColorInt borderUnseenColors: List<Int>?, @ColorInt textUnseenColor: Int?, badge: StoryGroupBadgeStyle?)

This class represents a story group's style in the StorylyView.

StoryGroupType

enum StoryGroupType : Enum<StoryGroupType>

This enum class represents the type of the story group.

StoryImageQuizComponent

data class StoryImageQuizComponent(id: String, title: String?, options: List<String>?, rightAnswerIndex: Int?, selectedOptionIndex: Int, customPayload: String?) : StoryComponent

This data class represents the ImageQuiz component.

StorylyDataSource

enum StorylyDataSource : Enum<StorylyDataSource>

This enum represents the source of the storyly data

StorylyInit

data class StorylyInit(storylyId: String, config: StorylyConfig) : BaseInit

This class triggers initialization of Storyly

StorylyLayoutDirection

enum StorylyLayoutDirection : Enum<StorylyLayoutDirection>

This enum class represents available layout direction that be can set for customization

StorylyListener

interface StorylyListener

This interface represents StorylyListener which notifies application when an event occurs in StorylyView.

StorylyProductListener

interface StorylyProductListener

This delegate represents the class which notifies application when an product related event occurs in StorylyView.

StorylyView

class StorylyView @JvmOverloads constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : FrameLayout

This class is the main view of Storyly.

StoryPollComponent

data class StoryPollComponent(id: String, title: String, options: List<String>, selectedOptionIndex: Int, customPayload: String?) : StoryComponent

This data class represents the Poll component.

StoryProductCardComponent

data class StoryProductCardComponent(id: String, text: String?, actionUrl: String?, products: List<STRProductItem>?, customPayload: String?) : StoryComponent

This data class represents the ProductCard component.

StoryProductCatalogComponent

data class StoryProductCatalogComponent(id: String, actionUrlList: List<String?>?, products: List<STRProductItem>?, customPayload: String?) : StoryComponent

This data class represents the ProductCatalog component.

StoryProductTagComponent

data class StoryProductTagComponent(id: String, actionUrl: String?, products: List<STRProductItem>?, customPayload: String?) : StoryComponent

This data class represents the ProductTag component.

StoryPromoCodeComponent

data class StoryPromoCodeComponent(id: String, text: String, customPayload: String?) : StoryComponent

This data class represents the PromoCode component.

StoryQuizComponent

data class StoryQuizComponent(id: String, title: String, options: List<String>, rightAnswerIndex: Int?, selectedOptionIndex: Int, customPayload: String?) : StoryComponent

This data class represents the Quiz component.

StoryRatingComponent