The entry class of video shopping.

Hierarchy

  • VideoShopping

Properties

onClickProduct?: ClickProductCallback

This callback is triggered when the user clicks product card. Only supported on iOS

onCustomClickCartIcon?: CustomClickCartIconCallback

This callback is triggered when the user clicks the shopping cart icon.

The host app can customize the click event processing logic of the shopping cart icon by setting the callback.

onShoppingCTA?: ShoppingCTACallback

This callback is triggered when the user clicks the "Add to cart" or "Shop now" button. The host app can return a ShoppingCTAResult object to tell SDK how to handle the result.

onUpdateProductDetails?: UpdateProductDetailsCallback

This callback is triggered when the video will be shown.

The host app can return a Product list to update the latest product information.

Accessors

  • get cartIconVisible(): boolean
  • Defaults to true. You can hide the cart icon by setting this property to false.

    Returns boolean

  • set cartIconVisible(value: boolean): void
  • Parameters

    • value: boolean

    Returns void

Methods

  • Parameters

    • count: number

      The number of items in the host app cart. The count should be greater than or equal to 0. We just use count to show or hide red indicator on the cart icon. If cound > 0, we will show the red indicator on the cart icon. Otherwise, we will hide the red indicator on the cart icon.

    Returns Promise<void>

Generated using TypeDoc