商品库

一、功能概述

本模块提供直播间商品展示和交互功能，包括获取商品列表、商品标签等。

二、Api 方法

2.1 获取商品库的商品列表

Api 方法： getProductListByShowId(params?: GetProductListParams): Promise<ProductListData>

参数说明：

• params：undefined，GetProductListParams 类型，选传

返回值说明： 商品列表数据，Promise<ProductListData> 类型

示例：

// 获取商品列表
const res = await watchCore.product.getProductListByShowId();
console.log('商品列表', res.content);

2.2 根据标签ID获取商品列表

Api 方法： getProductListByTagId(params: GetProductListByTagParams): Promise<ProductListPageData>

参数说明：

• params：查询参数，GetProductListByTagParams 类型，必传

返回值说明： 分页商品列表数据，Promise<ProductListPageData> 类型

示例：

// 获取指定标签的商品
const res = await watchCore.product.getProductListByTagId({
  tagId: '123456'
});
console.log('商品总数', res.totalItems);
console.log('当前页码', res.pageNumber);
console.log('总页数', res.totalPages);
console.log('商品列表', res.contents);

2.3 获取商品标签列表

Api 方法： getProductLabelList(params: GetProductLabelListParams): Promise<ProductLabelListData>

参数说明：

• params：获取参数，GetProductLabelListParams 类型，必传，详细类型说明如下

返回值说明： 商品标签列表数据，Promise<ProductLabelListData> 类型，详细类型说明如下

示例：

// 获取商品分类标签
const res = await watchCore.product.getProductLabelList({});
console.log('标签总数', res.totalItems);
console.log('当前页码', res.pageNumber);
console.log('总页数', res.totalPages);
console.log('标签列表', res.contents);

2.4 发送商品点击购买事件

说明： 用户点击商品购买按钮时调用，用于统计埋点和显示购买效果

Api 方法： sendClickBuy(good: ProductData): void

参数说明：

• good：商品数据，ProductData 类型，必传

示例：

// 用户点击购买商品
watchCore.product.sendClickBuy(productData);

三、模块事件

3.1 上架商品事件

说明： 当商品被上架时触发

Event 事件： ProductEvents.OnShelfProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.OnShelfProduct, (data) => {
  console.log('商品已上架', data.productData);
});

3.2 下架商品事件

说明： 当商品被下架时触发

Event 事件： ProductEvents.OffShelfProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.OffShelfProduct, (data) => {
  console.log('商品已下架', data.productData);
});

3.3 删除商品事件

说明： 当商品被删除时触发

Event 事件： ProductEvents.DeleteProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.DeleteProduct, (data) => {
  console.log('商品已删除', data.productData);
});

3.4 添加商品事件

说明： 当新商品被添加时触发

Event 事件： ProductEvents.AddProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.AddProduct, (data) => {
  console.log('商品已添加', data.productData);
});

3.5 修改商品事件

说明： 当商品信息被修改时触发

Event 事件： ProductEvents.ChangeProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.ChangeProduct, (data) => {
  console.log('商品已修改', data.productData);
});

3.6 移动商品事件

说明： 当商品位置被移动时触发

Event 事件： ProductEvents.MoveProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.MoveProduct, (data) => {
  console.log('商品已移动', data.productData);
});

3.7 修改排序事件

说明： 当商品排序被修改时触发

Event 事件： ProductEvents.ChangeRankProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.ChangeRankProduct, (data) => {
  console.log('商品排序已修改', data.productData);
});

3.8 刷新商品列表事件

说明： 当商品列表需要刷新时触发

Event 事件： ProductEvents.RefreshProductList

示例：

watchCore.product.eventEmitter.on(ProductEvents.RefreshProductList, () => {
  console.log('商品列表已刷新');
});

3.9 推送商品事件

说明： 当商品被推送给用户时触发

Event 事件： ProductEvents.PushProduct

回调参数： Object 对象，详细类型说明如下

示例：

watchCore.product.eventEmitter.on(ProductEvents.PushProduct, (data) => {
  console.log('商品已推送', data.productData);
});

3.10 商品点击次数事件

说明： 当商品被点击时触发，包含点击次数信息

Event 事件： ProductEvents.ProductClickTimes

回调参数： ProductClickTimesData

示例：

watchCore.product.eventEmitter.on(ProductEvents.ProductClickTimes, (data) => {
  console.log('商品点击次数', data);
});