Shortform API

숏폼 설치하기

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';

숏폼 실행하기

void play({required ShopLiveShortformCollectionData data})를 통해 Shortform 상세화면을 재생합니다.

• ShopLiveShortformCollectionData의 필드 값 중 하나 이상 넣으면 관련 상세화면을 재생할 수 있습니다.

ShopLiveShortformCollectionData

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

숏폼 종료하기

void close()를 통해 Shortform 상세화면을 종료합니다.

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

숏폼 상품 클릭 기능

Stream<ShopLiveShortformProductData> onClickProduct를 통해 Shoplive Shortform에서 직접 상품 클릭 기능을 개발합니다. Create a product 가이드를 참고합니다.

ShopLiveShortformProductData

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

숏폼 배너 클릭 기능

Stream<ShopliveShortformUrlData> onClickBanner를 통해 Shoplive Shortform에서 직접 배너 클릭 기능을 개발합니다. Create a banner 가이드를 참고합니다.

ShopLiveShortformProductData

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

숏폼 공유하기 클릭 기능

Stream<ShopLiveShortformShareData> onShare를 통해 Shoplive Shortform에서 직접공유하기 클릭 기능을 개발합니다.

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

숏폼 시작 알림 기능

Stream<ShopLiveBaseData> onStart를 통해 Shoplive Shortform이 시작 됐는지 알 수 있습니다.

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

숏폼 종료 알림 기능

Stream<ShopLiveBaseData> onClose를 통해 Shoplive Shortform이 종료 됐는지 알 수 있습니다.

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

숏폼 로그 기능

Stream<ShopliveShortformLogData> log를 통해 Shoplive Shortform이 로그를 확인할 수 있습니다.

• Shortform Events

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