StoryGroup

@objc(StoryGroup)
public final class StoryGroup : NSObject

This class represents a story group in the StorylyView.

  • ID of the story group

    Declaration

    Swift

    @objc
public let uniqueId: String

  • Title of the story group

    Declaration

    Swift

    @objc
public let title: String

  • URL of the story group icon image

    Declaration

    Swift

    @objc
public let iconUrl: URL?

  • URL of the story group icon video

    Declaration

    Swift

    @objc
public let iconVideoUrl: URL?

  • URL of the story group icon video thumbnail

    Declaration

    Swift

    @objc
public let iconVideoThumbnailUrl: URL?

  • Order index of the story group

    Declaration

    Swift

    @objc
public let index: Int

  • State of the story group that shows whether all of the stories are seen or not

    Declaration

    Swift

    @objc
public let seen: Bool

  • List of stories in the story group

    Declaration

    Swift

    @objc
public let stories: [Story]

  • Pin status of the story group that shows whether group is pinned or not

    Declaration

    Swift

    @objc
public let pinned: Bool

  • Type of the story group

    Declaration

    Swift

    @objc
public let type: StoryGroupType

  • Style of this group

    Declaration

    Swift

    @objc
public let style: StoryGroupStyle?

  • Name of this group

    Declaration

    Swift

    @objc
public let name: String?

  • Denotes whether story group is nudge or not

    Declaration

    Swift

    @objc
public let nudge: Bool

  • StoryGroup initialization

    Declaration

    Swift

    @objc
public init(
    id: String,
    title: String,
    iconUrl: URL?,
    iconVideoUrl: URL?,
    iconVideoThumbnailUrl: URL?,
    index: Int,
    seen: Bool,
    stories: [Story],
    pinned: Bool,
    type: StoryGroupType,
    style: StoryGroupStyle?,
    name: String?,
    nudge: Bool
)

    Parameters

    id

    ID of the story group
    title

    Title of the story group
    iconUrl

    URL of the story group icon image
    thematicIconUrls

    URLs of different the story group icon themes
    index

    Order index of the story group
    seen

    State of the story group that shows whether all of the stories are seen or not
    stories

    List of stories in the story group
    pinned

    Pin status of the story group that shows whether group is pinned or not
    type

    Type of the story group
    style

    Style of this group
    name

    Name of this group
    nudge

    Denotes whether story group is nudge or not