观看条件 - 验证码观看

一、设置信息

1.1 验证码观看条件设置信息

Interface 接口: AuthSettingItemCode

属性名说明类型

authType

条件类型

Code

enabled

是否启用

null | YN

privacyContent

隐私声明内容

string

privacyStatus

是否开启隐私声明

YN

codeAuthTips

欢迎标题

string

codeEntryText

入口文本

null | string

qcodeImg

二维码图片地址

string

qcodeTips

二维码提示文案

string

二、使用方式

2.1 验证验证码观看

Api 方法: verifyCodeAuth(params: VerifyCodeAuthParams): Promise<VerifyCodeAuthResult>

参数说明:

  • params:调用参数,VerifyCodeAuthParams 类型,必传,详细类型说明如下

参数名说明类型必须默认值

code

验证码

string

-

返回值说明: 授权结果,Promise<VerifyCodeAuthResult> 类型

示例:

// 执行验证码授权
async function toDoAuthCode(code) {
  const result = await watchCore.auth.verifyCodeAuth({
    code,
  });
  if (result.success) {
    await handleAuthVerifySuccess(result);
  } else {
    await handleAuthVerifyFail(result);
  }
}

// 传入验证码
toDoAuthCode('1234');

Last updated