react-native-firework-sdk
    Preparing search index...

    Interface IStoryBlockProps

    The props type of StoryBlock component.

    interface IStoryBlockProps {
        adConfiguration?: AdConfiguration;
        channel?: string;
        contentId?: string;
        cornerRadius?: number;
        dynamicContentParameters?: { [key: string]: string[] };
        enablePictureInPicture?: boolean;
        hashtagFilterExpression?: string;
        onStoryBlockDidStartPictureInPicture?: (error?: FWError) => void;
        onStoryBlockDidStopPictureInPicture?: (error?: FWError) => void;
        onStoryBlockEmpty?: (error?: FWError) => void;
        onStoryBlockGetFeedId?: (feedId: string) => void;
        onStoryBlockLoadFinished?: (error?: FWError) => void;
        playlist?: string;
        productIds?: string[];
        source: StoryBlockSource;
        storyBlockConfiguration?: StoryBlockConfiguration;
        style?: StyleProp<ViewStyle>;
    }
    Index

    Properties

    adConfiguration? channel? contentId? cornerRadius? dynamicContentParameters? enablePictureInPicture? hashtagFilterExpression? onStoryBlockDidStartPictureInPicture? onStoryBlockDidStopPictureInPicture? onStoryBlockEmpty? onStoryBlockGetFeedId? onStoryBlockLoadFinished? playlist? productIds? source storyBlockConfiguration? style?

    Properties

    adConfiguration?: AdConfiguration

    Ad configuration of the feed.

    channel?: string

    Channel id of the story block. Required when the source is set as channel or playlist or dynamicContent.

    contentId?: string

    The video or live stream id.

    cornerRadius?: number

    The corner radius of story block.

    dynamicContentParameters?: { [key: string]: string[] }

    The dynamic content parameters of the story block. Required when the source is set as dynamicContent.

    enablePictureInPicture?: boolean

    Specifies if Picture in Picture is enabled. Only supported on iOS.

    hashtagFilterExpression?: string

    Hashtag filter expression is an s-expression used to provide feeds filtered by hashtags with specified criteria. Queries are specified with boolean predicates on what hashtags are there on the video. For instance, (and sport food) (or sport food) (and sport (or food comedy)) sport are all valid expressions. Non-UTF-8 characters are not allowed. If using boolean predicates, the expression needs to be wrapped with parenthesis.

    onStoryBlockDidStartPictureInPicture?: (error?: FWError) => void

    Start Picture in Picture callback. Only supported on iOS.

    onStoryBlockDidStopPictureInPicture?: (error?: FWError) => void

    Stop Picture in Picture callback. Only supported on iOS.

    onStoryBlockEmpty?: (error?: FWError) => void

    The callback is triggered when there are no items in the story block. The callback is triggered in the following cases:

    1. Loading successfully but the back end returns an empty list.
    2. The load failed and list is empty. onStoryBlockLoadFinished will also be triggered when onStoryBlockEmpty is triggered.
    onStoryBlockGetFeedId?: (feedId: string) => void

    The host app could use this callback to get feed id. The feed id can be used for conversion tracking.

    onStoryBlockLoadFinished?: (error?: FWError) => void

    The feed loading result callback. It means loading successfully when error equals to undefined.

    playlist?: string

    Playlist id of the story block. Please note channel id is necessary. Required when the source is set as playlist.

    productIds?: string[]

    Product ids used to generate the sku feed

    source: StoryBlockSource

    One of four available story block sources.

    storyBlockConfiguration?: StoryBlockConfiguration
    style?: StyleProp<ViewStyle>

    Standard React Native View Style.

    Settings

    Member Visibility

    On This Page

    Properties