保利威文档中心

幫助中心

按讚

更新時間:2024-10-10 17:27:10

一、功能概述

聊天室模块(chat) 提供按讚功能 Api,供開發者整合按讚功能。

二、使用方式 - 方法

2.1 取得即時按讚數

收到使用者按讚事件後可透過此方法取得即時按讚數,透過 ChatEvents.ChatLikeCountChange 事件監聽按讚數變更。

Api 方法: getRealtimeLikes(): number

範例:

const realtimeLikes = watchCore.chat.getRealtimeLikes();
console.log('实时点赞数:', realtimeLikes);

2.2 傳送按讚數

Api 方法: sendLike(times: number): Promise<number>

參數說明:

  • times:按讚數,number 類型,必填

回傳值說明: Promise<number> 類型

// 当前点赞数
let currentRealtimeLikes = 0;
// 待发送的点赞数
let waitSendLikes = 0;

/** 处理点击点赞按钮 */
function onClickLikeButton() {
  currentRealtimeLikes++;
  waitSendLikes++;
}

/** 将待发送的点赞数发送到服务端 */
async function toSendLike() {
  if (!waitSendLikes) {
    return;
  }

  try {
    const realtimeLikes = await watchCore.chat.sendLike(waitSendLikes);
    currentRealtimeLikes = realtimeLikes;
  } finally {
    // 清空待点赞数
    waitSendLikes = 0;
  }
}

// 每 5 秒中发送一次点赞,避免频繁请求
window.setInterval(() => {
  toSendLike();
}, 5000);

document.querySelector('.like-button').addEventListener('click', onClickLikeButton);

三、使用方式 - 事件

3.1 按讚數修改事件

說明: 透過此事件監聽按讚數變更事件,回呼後更新頁面的按讚數顯示。

Event 事件: ChatEvents.ChatLikeCountChange

回呼參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
realtimeLikes 即時按讚數 number

範例:

watchCore.chat.eventEmitter.on(ChatEvents.ChatLikeCountChange, (data) => {
  console.log('实时点赞数:', data.realtimeLikes);
});

3.2 按讚事件

說明: 透過此事件監聽使用者的按讚事件

Event 事件: ChatEvents.ChatLike

回呼參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
count 按讚數 number
realtimeLikes 即時按讚數 number
userId 使用者 id string
nick 使用者暱稱 string
isSelf 是否自己按讚 boolean

範例:

watchCore.chat.eventEmitter.on(ChatEvents.ChatLike, (data) => {
  console.log('实时点赞数:', data.realtimeLikes);
  console.log('该观众的点赞次数', data.count);
  console.log('点赞的观众 id', data.userId);
  console.log('点赞的观众昵称', data.nick);
});
联系客服,在线咨询