Polyv Help Center

Help Center

Module Events

Updated: 2025-07-03 14:46:06

1. Checking In Event

Description: This event is triggered when a user is currently checking in.

Event: CheckInEvent.OnCheckIn

Callback Parameters: Object object, detailed type description as follows:

Property Description Type
isCheckInProcessing Whether currently checking in boolean

Example:

checkInTarget.eventEmitter.on(CheckInEvent.OnCheckIn, (data) => {
  console.log('是否处于签到中', data.isCheckInProcessing);
});

2. Start Check-in

Description: This event is triggered when a user starts a check-in.

Event: CheckInEvent.StartCheckIn

Callback Parameters: Object object, detailed type description as follows:

Property Description Type
checkInData Check-in data CheckInData

Example:

checkInTarget.eventEmitter.on(CheckInEvent.StartCheckIn, (data) => {
  console.log('开始签到', data.checkInData);
});

3. Check-in Countdown

Description: This event is triggered when a user starts a check-in.

Event: CheckInEvent.CheckInCountdown

Callback Parameters: Object object, detailed type description as follows:

Property Description Type
remainingTime Countdown time number

Example:

checkInTarget.eventEmitter.on(CheckInEvent.CheckInCountdown, (data) => {
  console.log('签到倒计时', data.remainingTime);
});

4. Stop Check-in

Description: This event is triggered when a user ends a check-in.

Event: CheckInEvent.StopCheckIn

Callback Parameters: Object object, detailed type description as follows:

Property Description Type
checkInId Check-in ID string
checkInCount Number of check-ins number

Example:

checkInTarget.eventEmitter.on(CheckInEvent.StopCheckIn, (data) => {
  console.log('结束签到', data.checkInId);
});

5. Check-in Success

Description: This event is triggered when a user successfully checks in.

Event: CheckInEvent.CheckInSuccess

Callback Parameters: null

Example:

checkInTarget.eventEmitter.on(CheckInEvent.CheckInSuccess, () => {
  console.log('签到成功');
});

6. Check-in Failure

Description: This event is triggered when a user fails to check in.

Event: CheckInEvent.CheckInFail

Callback Parameters: Object object, detailed type description as follows:

Property Description Type
failReason Reason for check-in failure CheckInFailReason

Example:

checkInTarget.eventEmitter.on(CheckInEvent.CheckInFail, (data) => {
  console.log('签到失败', data.failReason);
});
联系客服,在线咨询