Shortform API

Installing a short-form

https://pub.dev/packages/shoplive_player/install

Depend on it

Run this command:

With Flutter:

 $ flutter pub add shoplive_player

This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):

dependencies:
  shoplive_player: ^1.6.5

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

Import it

Now in your Dart code, you can use:

import 'package:shoplive_player/shoplive_player.dart';

Run a short-form

void play({required ShopLiveShortformCollectionData data})to play back the Shortform details.

• ShopLiveShortformCollectionDataIf you put one or more of the field values in , you can play the related detail screen.

ShopLiveShortformCollectionData

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.play(data: data);

Ending a short-form

void close()to exit the Shortform detail screen.

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.close();

Ability to click on short-form products

Stream<ShopLiveShortformProductData> onClickProductThrough Shoplive we develop the ability to click products directly in Shortform. Create a product refer to the guide.

ShopLiveShortformProductData

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.onClickProduct.listen((data) {
  _showToast("onClickProduct : ${data.productId} ");
});

Short-form banner clickability

Stream<ShopliveShortformUrlData> onClickBannerThrough Shoplive you develop banner clicks directly in Shortform. Create product banner refer to the guide.

ShopLiveShortformProductData

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.onClickBanner.listen((data) {
  _showToast("onClickBanner : ${data.url} ");
});

Click to share short-form

Stream<ShopLiveShortformShareData> onShareDevelop a Share click feature directly from Shoplive Shortform.

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.onShare.listen((data) {
  _showToast("onClickShare : ${data.shortsId}, ${data.title}  ");
});

Short-form start notification function

Stream<ShopLiveBaseData> onStartlets you know if Shoplive Shortform has started.

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.onStart.listen((data) {
  _showToast("onShortformStarted");
});

Short-form end notification function

Stream<ShopLiveBaseData> onCloselets you know if your Shoplive Shortform has been shut down.

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.onClose.listen((data) {
  _showToast("onShortformClosed");
});

Short-form log feature

Stream<ShopliveShortformLogData> logallows Shoplive Shortform to check the logs.

• Shortform Events

late final _shopLiveShortformPlugin = ShopLiveShortform();
_shopLiveShortformPlugin.log.listen((data) {
  _showToast("onShortformEventLog : ${data.command}, ${data.payload} ");
});