Interface IStoryBlockProps

The props type of StoryBlock component.

Hierarchy

  • IStoryBlockProps

Properties

adConfiguration? channel? dynamicContentParameters? enablePictureInPicture? hashtagFilterExpression? onStoryBlockLoadFinished? playlist? source style?

Properties

Optional adConfiguration

adConfiguration?: AdConfiguration

Ad configuration of the feed. Only supported on iOS.

Optional channel

channel?: string

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

Optional dynamicContentParameters

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

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

Type declaration

  • [key: string]: string[]

Optional enablePictureInPicture

enablePictureInPicture?: boolean

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

Optional hashtagFilterExpression

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. Only supported on iOS.

Optional onStoryBlockLoadFinished

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

Type declaration

    • (error?: FWError): void

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

      Parameters

      Returns void

Optional playlist

playlist?: string

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

source

source: StoryBlockSource

One of four available story block sources.

Optional style

style?: StyleProp<ViewStyle>

Standard React Native View Style.

Settings

Member Visibility

Theme

Generated using TypeDoc