觀看條件 - 登記觀看
更新時間:2024-10-10 17:27:10
一、設定資訊
1.1 登記觀看條件設定資訊
Interface 介面: AuthSettingItemInfo
| 屬性名 | 說明 | 類型 |
|---|---|---|
authType |
條件類型 | Info |
privacyContent |
隱私聲明內容 | string |
privacyStatus |
是否開啟隱私聲明 | YN |
infoAuthTips |
歡迎標題 | string |
infoDesc |
提示資訊 | string |
infoEntryText |
入口文字 | null | string |
1.2 登記觀看的表單選項
Interface 介面: AuthInfoItem
| 屬性名 | 說明 | 類型 |
|---|---|---|
type |
表單類型 | AuthInfoType |
name |
資訊標題 | string |
placeholder |
資訊描述 | string |
sms |
是否需要簡訊驗證 | YN |
options |
下拉選項列表,用英文逗號隔開 | string |
1.3 登記觀看的選項類型
Enum 列舉: AuthInfoType
| 常數 | 列舉成員 | 說明 |
|---|---|---|
'name' |
AuthInfoType.Name |
姓名 |
'text' |
AuthInfoType.Text |
文字 |
'mobile' |
AuthInfoType.Mobile |
手機號碼 |
'option' |
AuthInfoType.Option |
下拉選項 |
'number' |
AuthInfoType.Number |
數值 |
二、使用方式
2.1 取得登記觀看表單設定列表
Api 方法: getAuthInfoFields(): AuthInfoItem[]
回傳值說明: 表單設定列表,AuthInfoItem[] 類型
範例:
const formFields = watchCore.auth.getAuthInfoFields();
formFields.forEach(fieldItem => {
console.log('表单项信息', fieldItem);
console.log('表单类型', fieldItem.type);
});
2.2 驗證登記觀看
透過 verifyInfoAuth 傳入 formValues 進行驗證登記觀看,如果後台設定了手機號碼的登記選項,需要另外傳入 phoneNumber、areaCode、smsCore 這三個欄位。
Api 方法: verifyInfoAuth(params: VerifyInfoAuthParam): Promise<VerifyInfoAuthResult>
參數說明:
- params:呼叫參數,
VerifyInfoAuthParam類型,必傳,詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
phoneNumber |
手機號 | string |
否 | - |
areaCode |
手機區號 | string |
否 | - |
smsCode |
簡訊驗證碼 | string |
否 | - |
formValues |
登記填寫資訊 | string[] |
是 | - |
回傳值說明: 授權結果,Promise<VerifyInfoAuthResult> 類型
範例:
// 登记观看表单列表结构示例:
// [mobile(手机号码), name(姓名), text(职业), number(年龄), option(城市->广州,深圳,佛山,惠州)]
// 执行登记观看验证
async function toDoAuthInfo(form) {
const result = await watchCore.auth.verifyInfoAuth({
code,
});
if (result.success) {
await handleAuthVerifySuccess(result);
} else {
await handleAuthVerifyFail(result);
}
}
// 提交的表单内容
toDoAuthInfo({
phoneNumber: '18012345678',
areaCode: '+86',
smsCode: '76431',
formValues: ['18012345678', '李小明', '前端开发工程师', '18', '广州'],
});
2.3 登入登記觀看
當後台設定了手機號碼的表單選項後,如果觀眾已提交過登記表單時,可呼叫 loginInfoAuth 方法,傳入手機號碼資訊進行驗證,如果已存在登記資訊則可直接進入觀看頁。
Api 方法: loginInfoAuth(params: LoginInfoAuthParams): Promise<LoginInfoAuthResult>
參數說明:
- params:呼叫參數,
LoginInfoAuthParams類型,必傳,詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
phoneNumber |
手機號 | string |
是 | - |
areaCode |
手機區號 | string |
是 | - |
回傳值說明: 登入結果,Promise<LoginInfoAuthResult> 類型
範例:
async function submitAuthLogin(phoneNumber, areaCode) {
const result = await watchCore.auth.loginInfoAuth({
phoneNumber: phoneNumber,
areaCode: areaCode,
});
if (result.success) {
handleAuthVerifySuccess(result);
} else {
handleAuthVerifyFail(result);
}
}
