簽到

功能概述

本模組主要用於接收和處理講師、助教和管理員等使用者發起的簽到操作。

初始化及銷毀

在實例化該模組並進行使用之前，需要對 SDK 進行初始化配置，詳細請見參考文件。

線上檔案引入方式

// script 标签引入，根据版本号引入JS版本。
<script src="https://websdk.videocc.net/interactions-receive-sdk/0.24.0/lib/polyv-ir.umd.js"></script>

<script>
    const { CheckIn } = window.PolyvIRSDK;
</script>

import 方式引入（推薦）

import { CheckIn } from '@polyv/interactions-receive-sdk';

const checkInSdk = new CheckIn();
// ...
// 销毁 SDK 实例，清除逻辑
checkInSdk.destroy();

使用流程

監聽「開始簽到」事件

在講師/助教等發起端，發起一次簽到之後，checkInSdk.events.SIGN_IN 事件會被觸發，事件參數中包含簽到總時長等資訊，接入方可以監聽該事件，並根據這些資訊，展示簽到倒數計時等介面。

checkInSdk.on(checkInSdk.events.SIGN_IN, function(msg) {
  console.log(`开始签到，签到时长：`, msg.data.limitTime, `签到提示：`, msg.data.message);
});

監聽「簽到中止」事件

在預設倒數計時結束前，發起端若主動結束簽到，checkInSdk.events.STOP_SIGN_IN 事件會被觸發，此後觀眾將無法提交簽到資訊，因此在收到此事件時接入方應展示簽到終止提示，不再允許使用者進行簽到。

checkInSdk.on(checkInSdk.events.STOP_SIGN_IN, function(msg) {
  console.log('签到已终止');
});

監聽「簽到時間結束」事件

在預設簽到時間結束後，checkInSdk.events.SIGN_IN_FINISH 事件會被觸發。類似於 checkInSdk.events.STOP_SIGN_IN 事件，接入方需要展示類似簽到已結束的提示。

checkInSdk.on(checkInSdk.events.SIGN_IN_FINISH, function(msg) {
  console.log('签到已结束');
});

監聽「計時更新」事件

在簽到開始後，SDK 內部會啟動倒數計時處理邏輯，每當簽到剩餘時間更新時，checkInSdk.events.SIGN_IN_TIME_UPDATED 事件都會被觸發（每秒更新後觸發一次），接入方除了自行處理「簽到開始」時間中的時間，也可以直接監聽此事件進行相應時間處理和展示。

checkInSdk.on(checkInSdk.events.SIGN_IN_TIME_UPDATED, function(msg) {
  console.log('剩余签到时间(毫秒)：', msg.totalMsecs);
});

進行簽到

在簽到開始後，可以使用 checkInSdk.toCheckIn() 進行使用者簽到，簽到成功後將觸發相應事件。

監聽「簽到成功」事件

checkInSdk.on(checkInSdk.events.SIGN_IN_SUCCESS, function() {
  console.log('签到成功');
});

注意

如果不需要再使用簽到 SDK 時，請呼叫 SDK 實例的 destroy 方法去銷毀實例。