Package com.appsamurai.storyly

Types

PlayMode
Link copied to clipboard
enum PlayMode : Enum<PlayMode>

This data class represents the preview mode of stories.

Story
Link copied to clipboard
data class Story(uniqueId: String, title: String, name: String?, index: Int, seen: Boolean, currentTime: Long, media: StoryMedia)

This data class represents a story inside a story group.

StoryCommentComponent
Link copied to clipboard
data class StoryCommentComponent(id: String, text: String) : StoryComponent

This data class represents the Comment component.

StoryComponent
Link copied to clipboard
open class StoryComponent(id: String, type: StoryComponentType)

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

StoryComponentType
Link copied to clipboard
enum StoryComponentType : Enum<StoryComponentType>

This enum class represents the type of the components.

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

This data class represents the Emoji component.

StoryGroup
Link copied to clipboard
data class StoryGroup(uniqueId: String, title: String, iconUrl: String, thematicIconUrls: Map<String, String>?, coverUrl: String?, index: Int, seen: Boolean, stories: List<Story>, pinned: Boolean, type: StoryGroupType)

This data class represents a story group in the StorylyView.

StoryGroupSize
Link copied to clipboard
enum StoryGroupSize : Enum<StoryGroupSize>

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

StoryGroupType
Link copied to clipboard
enum StoryGroupType : Enum<StoryGroupType>

This enum class represents the type of the story group.

StorylyDataSource
Link copied to clipboard
enum StorylyDataSource : Enum<StorylyDataSource>

This enum represents the source of the storyly data

StorylyInit
Link copied to clipboard
data class StorylyInit(storylyId: String)

This class triggers initialization of Storyly

StorylyLayoutDirection
Link copied to clipboard
enum StorylyLayoutDirection : Enum<StorylyLayoutDirection>

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

StorylyListener
Link copied to clipboard
interface StorylyListener

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

StorylyMomentsListener
Link copied to clipboard
interface StorylyMomentsListener
StorylySegmentation
Link copied to clipboard
data class StorylySegmentation(segments: Set<String>?)

This class is used in Storyly initialization if you are planning to target labeled story groups which are set in dashboard

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

This class is the main view of Storyly.

StoryMedia
Link copied to clipboard
data class StoryMedia(type: StoryType, storyComponentList: List<StoryComponent>?, actionUrlList: List<String>?, actionUrl: String?, previewUrl: String?)

This data class represents the media of a story.

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

This data class represents the Poll component.

StoryPromoCodeComponent
Link copied to clipboard
data class StoryPromoCodeComponent(id: String, text: String) : StoryComponent

This data class represents the PromoCode component.

StoryQuizComponent
Link copied to clipboard
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
Link copied to clipboard
data class StoryRatingComponent(id: String, emojiCode: String, rating: Int, customPayload: String?) : StoryComponent

This data class represents the Rating component.

StoryType
Link copied to clipboard
enum StoryType : Enum<StoryType>

This enum class represents the type of a story content

Properties

ShowFailed_AlreadyShowing
Link copied to clipboard
val ShowFailed_AlreadyShowing: String
ShowFailed_EmptyData
Link copied to clipboard
val ShowFailed_EmptyData: String
ShowFailed_InvalidStory
Link copied to clipboard
val ShowFailed_InvalidStory: String
ShowFailed_InvalidStoryGroup
Link copied to clipboard
val ShowFailed_InvalidStoryGroup: String