iOS SDK UI自定義配置說明
金融級實人認(rèn)證服務(wù)iOS SDK提供自定義UI顏色、icon圖標(biāo)和UI文案的接口,開發(fā)者可以通過調(diào)用setCustomUI
或setCustomTxtConfig
接口進(jìn)行自定義。本文為您介紹UI自定義接口說明以及相關(guān)的代碼示例。
部分自定義配置可能需要依賴SDK升級,建議您在使用之前將SDK升級至最新版本。
自定義UI顏色和icon圖標(biāo)
目前僅支持自定義引導(dǎo)頁和活體認(rèn)證頁的顏色和icon圖標(biāo)。
接口說明
iOS SDK中提供了自定義UI顏色和icon圖標(biāo)的接口:setCustomUI
。
/**
* 設(shè)置自定義UI
* @param customConfig
* 傳入JSON文件路徑或者JSON字符串
* @param type
* 傳入的config類型path或者json
* @param completion配置文件結(jié)果回調(diào)
* */
+ (void)setCustomUI:(nonnull NSString *)configuration type:(nonnull NSString *)type completion:(void(^)(BOOL success, NSError *error))completion;
參數(shù)說明
名稱
類型
說明
configuration
NSString
配置自定義入?yún)⒌念愋停?/p>
json:傳入JSON字符串。
path:傳入JSON文件的沙盒路徑。
type
NSString
根據(jù)傳入的configuration,選擇傳入json或path。
completion
block
結(jié)果信息回調(diào)。
success為YES表示設(shè)置成功。
success為NO表示設(shè)置的內(nèi)容存在問題,具體請查看對應(yīng)返回的error說明。
返回值:無。
示例代碼
//傳入文件路徑
NSString *path = @"/var/mobile/Containers/Data/Application/C9DF10E6-7AB4-4C66-A180-DF1080C93F72/Documents/uiCustom.json";
[AliyunFaceAuthFacade setCustomUI:path type:@"path" completion:^(BOOL success, NSError * _Nonnull error) {
NSLog(@"%@",error.localizedDescription);
}];
//傳入JSON字符串
NSString *jsonString = @"{""\"guideConfig\": \"#FF0000\""}";
[AliyunFaceAuthFacade setCustomUI:jsonString type:@"json" completion:^(BOOL success, NSError * _Nonnull error) {
NSLog(@"%@",error.localizedDescription);
}];
字段定義
字段列表
{
"guideConfig": {
"titleColor": "#111111",
"titleBackPath": "",
"titleBackBase64": "",
"titleClosePath": "",
"titleCloseBase64": "",
"bannerImg": "",
"agrtUnSelColor": "#c5c5c5",
"agrtSelBgColor": "#ff6a00",
"agrtAgreeColor": "#333333",
"agrtColor": "#ff6a00",
"startBtnColor": "#ffffff",
"agrtBotTipsColor": "#333333",
"startBtnDisColor": "#ffffff",
"startBtnBgColor": "#ff6a00",
"startBtnDisBgColor": "#d9d9d9",
"elderBtnDisColor": "#ffffff",
"elderBtnBgColor": "#f0f0f0",
"elderBtnDisBgColor": "#d9d9d9",
"exitBtnColor": "#333333",
"exitBtnBgColor": "#ffffff",
"elderBtnColor": "#ff6a00",
"rareFormEntBtnColor": "#ff6a00",
"permissionToastBgColor": "#ffffff",
"permissionToastTitleColor": "#000000",
"permissionToastMsgColor": "#000000",
"dialogExitTitleColor": "#000000",
"dialogExitMsgColor": "#000000",
"dialogExitCancelColor": "#0E83E6",
"dialogExitConfirmColor": "#0E83E6",
"dialogPermissionFailedTitleColor": "#000000",
"dialogPermissionFailedMsgColor": "#000000",
"dialogPermissionFailedConfirmColor": "#0E83E6",
"dialogSupportFailedTitleColor": "#000000",
"dialogSupportFailedMsgColor": "#000000",
"dialogSupportFailedConfirmColor": "#0E83E6",
"dialogNetworkFailedTitleColor": "#000000",
"dialogNetworkFailedMsgColor": "#000000",
"dialogNetworkFailedConfirmColor": "#0E83E6"
},
"faceConfig": {
"faceBgColor": "#FFFFFF",
"faceTitleColor": "#000000",
"circleTxtBgAlpha": "0.25",
"dialogBgAlpha": "0.25",
"faceProgressStartColor": "#dfe6eb",
"faceProgressEndColor": "#FF6A00",
"circleTxtColor": "#ffffff",
"exitIconPath": "",
"exitIconBase64": "",
"submitTextColor": "#E4E4E4",
"submitLoadingIconBase64": "",
"submitLoadingIconPath": "",
"dialogExitTitleColor": "#000000",
"dialogExitMsgColor": "#000000",
"dialogExitCancelColor": "#0E83E6",
"dialogExitConfirmColor": "#0E83E6",
"dialogTimeOutTitleColor": "#000000",
"dialogTimeOutMsgColor": "#000000",
"dialogTimeOutConfirmColor": "#0E83E6",
"dialogNetworkFailedTitleColor": "#000000",
"dialogNetworkFailedMsgColor": "#000000",
"dialogNetworkFailedConfirmColor": "#0E83E6",
"dialogArchSysFailedTitleColor": "#000000",
"dialogArchSysFailedMsgColor": "#000000",
"dialogArchSysFailedConfirmColor": "#0E83E6",
"dialogTooManyRetriesTitleColor": "#000000",
"dialogTooManyRetriesMsgColor": "#000000",
"dialogTooManyRetriesConfirmColor": "#0E83E6",
"dialogInterruptTitleColor": "#000000",
"dialogInterruptMsgColor": "#000000",
"dialogInterruptConfirmColor": "#0E83E6",
"dialogInterruptCancelColor": "#0E83E6",
"dialogSDKErrTitleColor": "#000000",
"dialogSDKErrMsgColor": "#000000",
"dialogSDKErrConfirmColor": "#0E83E6",
"dialogCamOpenFailedTitleColor": "#000000",
"dialogCamOpenFailedMsgColor": "#000000",
"dialogCamOpenFailedConfirmColor": "#0E83E6",
"dialogCamOpenFailedCancelColor": "#0E83E6",
"noticeIconPath": "",
"noticeIconBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAKKADAAQAAAABAAAAKAAAAAB65masAAAEgElEQVRYCc1ZW2gVVxRd10d9pcVXo0arxkiKGlFr/bAgCPql+IoRW1pBabUqSqXQ74mW9qP40VJKWxFLERVFjREjih8qfuiHQUQtWiMK1sQY2oqPpL4yXevee8zM3Jm558abeDdszpmzH2fNnjP77DOTQCfJdd0ymi4iTyeXeJhdNHq4nv3aRCJxQ4IuJYIqJm8hXyLnSrKRbXHeQdJpEdkhPyS/KsmHQy7KC1A6qiTfJeeb5LOy0yBpnCA75HZyV5F8O+RETkBp0I+8j9xdpLn6WYGkoiLXneBMEDRn9khSyTEWubRtz1z3m2Ou++UB121oycXSp+sEo+hDTFUt2v1k33jQKHjd9ABYtRO4cDslKeoDfF8FLJgc1Mx67VKjijnzoNF8CYTg9No3kIcZYbb20RNgz3nguxPAg/8ytRdPAb6aC4x/O1MWM9JM2XiCfCQdL0CFt1qDQXrRDtRdAS7+BbTzHv9pBW60AFeagNanQe3M63Km5nLe9oi3gL69gSEDgGXvAUPZRlA1AW6WLAmQ0VN211YUmjx/PkPkdVLPH70/mje9PtKfoldGkPd6pFU2sg0FJ/k1BT3P9Oe9WIfCskEaBuDiWPXXI1ySBMjHq6qk4vVgiJ21QtgUQZVMXUbvDAJObQIOr+3UFIsEUPVcLPXuGSuOFJYOTQGbMDzzbbf0Ob0XvavYjKX+b8SKQ4VKLQdWA8VvAmdvAp/u8qtZ+ixRBLMCHBAC8LcVgFi7RpAmjQAOfZ4Cd/o68NEO4DGTupfCfHrl6b4dwJKBftMEs2cZd4d5k7gvMkoD+3fIp44CDq5JJeMTV4EVvwNtzzrkphf0acYDbRKg9r9YGjvYL3Zpoajc+huYJkAEqd1hxhgC/oyAWTgd5c6j/fnJc7+tuSodYnqxras1yA0LXCnRNJGPTFETMEN37gMLf02tMz3SI+uA4dzKtLZqLjLL7gOevzDama1sLKhJa7Axm+JgPkIt+iA1s4pZQpB/3AXG8Y0VuL31wPq98eDkZ2Zp0FvodaMVQJnOeTfUAVq4a1ZuSz3SH04CX+xnQcHiIo7G8vHqhiwoCZD3nJ2WTo3W+bc1td6+Pe5fBlEWVdOiJBnj9YpgbcZwyEAFk9Hs8hBBjkNKS6tmWhvV9mBJozLrso2JM4/VhW7pFWjj7Ng60Ov5srCZ6Wq8kqj+RG5Zy1lodpZGMp+unWVtncTE5KF1E1+wel0+fsrqgm/upTve0ex97Rw13F2mjMyuSw2+ep6CVZUrB7bamGqi3SsBVSm21IvFxvZPrMHJ7dY0Jt+ZpIiCBrLVoan5IbBmN3DupvxF0zAm718+BD4YF60TkKh+zzw0SYmPupINM1kHcI1HkQ5TP54GfiIHT3V6mZSaqudbvxSaRntV+LHTgCBIh/1qc23T3m9LHT/rmAtUtSgdfTwj5+Ompnp5mouclwAL+9OHkBNk4X48MqFNR9JhW3if3wzIdDQL8wNmAGThfgIOANVH9K/J3fYRPbnVeUHY9glSB36dqXVs1cHLMLv5+w3xPyaCG6DbMlfXAAAAAElFTkSuQmCC",
"noticeTxtColor": "#1677FF",
"noticeBgColor": "#0F1677FF"
}
}
對應(yīng)列表
展開折疊面板查看字段詳細(xì)說明。
自定義UI顏色和icon字段詳細(xì)說明
模塊 | key | 截圖 | 補(bǔ)充說明 |
guideConfig(引導(dǎo)頁) | titleColor | 標(biāo)題刷臉認(rèn)證字體顏色。 示例值“#111111”。 | |
agrtTopTipsColor | 協(xié)議頂部提示文本顏色。 示例“#111111” | ||
bannerImg | 示例圖。 僅可配置圖片的本地路徑。支持Base64格式(需要固定開頭,例如:“data:image/jpeg;base64,/9j...”)。 說明 不支持來源于外部網(wǎng)絡(luò)鏈接的圖片。 | ||
agrtUnSelColor | 勾選框未選中顏色。 | ||
agrtSelBgColor | 勾選框選中顏色。 | ||
agrtAgreeColor | 同意字體顏色。 | ||
agrtColor | 《認(rèn)證服務(wù)協(xié)議》顏色。 | ||
agrtBotTipsColor | 同意認(rèn)證后,……顏色。 | ||
startBtnBgColor | 開始認(rèn)證按鈕背景顏色。 | ||
startBtnDisBgColor | 未選中同意時,即按鈕不可用狀態(tài)下開始認(rèn)證按鈕的背景顏色。 | ||
startBtnDisColor | 未選中同意時,即按鈕不可用狀態(tài)下開始認(rèn)證按鈕的文字顏色。 | ||
startBtnColor | 開始認(rèn)證按鈕字體顏色。 | ||
exitBtnBgColor | 暫不認(rèn)證按鈕背景顏色。 | ||
exitBtnColor | 暫不認(rèn)證按鈕字體顏色。 | ||
elderBtnColor | 長輩模式認(rèn)證按鈕字體顏色 | 適老化(選擇)模式。 | |
elderBtnBgColor | 長輩模式認(rèn)證按鈕背景顏色。 | ||
elderBtnDisBgColor | 長輩模式認(rèn)證按鈕禁用(暫不可點擊)背景顏色。 | ||
rareFormNameColor | 生僻字模式,姓名字體顏色。 | 生僻字模式。 | |
rareFormIDColor | 生僻字模式,身份證號字體顏色。 | ||
rareFormEntBtnColor | 生僻字模式,錄入生僻字按鈕文本顏色。 | ||
titleBackPath | 無。 | 標(biāo)題欄返回icon圖標(biāo)。 路徑優(yōu)先級低于Base64編碼。 | |
titleBackBase64 | |||
titleClosePath | 標(biāo)題欄關(guān)閉icon圖標(biāo)。 路徑優(yōu)先級低于Base64編碼。 | ||
titleCloseBase64 | |||
permissionToastTitleColor | 權(quán)限兜底toast的標(biāo)題字體顏色。 | ||
permissionToastMsgColor | 權(quán)限兜底toast的內(nèi)容字體顏色。 | ||
permissionToastBgColor | 權(quán)限兜底toast背景顏色。 | ||
dialogPermissionFailedTitleColor | 權(quán)限拒絕彈框配色。 | ||
dialogPermissionFailedMsgColor | |||
dialogPermissionFailedConfirmColor | |||
dialogPermissionFailedConfirmColor | |||
dialogExitTitleColor | 退出彈窗配色。 | ||
dialogExitMsgColor | |||
dialogExitCancelColor | |||
dialogExitConfirmColor | |||
faceConfig(刷臉頁) | faceBgColor | 刷臉頁背景色。 | |
faceTitleColor | 刷臉頁標(biāo)題字體顏色。 | ||
faceProgressEndColor | 取景框(環(huán)形進(jìn)度條)顏色色值。 | ||
circleTxtBgAlpha | 蒙層不透明度。 取值范圍(0,1)。 | ||
circleTxtColor | 蒙層上方文案顏色。 | ||
dialogBgAlpha | 彈窗背景蒙層不透明度。 取值范圍:(0,1)。 | ||
exitIconPath | 退出圖標(biāo)路徑。 | ||
exitIconBase64 | 退出icon圖片base64。 | ||
submitTextColor | 認(rèn)證提交loading提示文案字體顏色。 | ||
submitLoadingIconBase64 | loading圖標(biāo)Base64。 | ||
submitLoadingIconPath | loading圖標(biāo)路徑。 | ||
dialogExitTitleColor | 退出彈框配色。 | ||
dialogExitMsgColor | |||
dialogExitCancelColor | |||
dialogExitConfirmColor | |||
dialogTimeOutTitleColor | 操作超時彈框配色。 | ||
dialogTimeOutMsgColor | |||
dialogTimeOutConfirmColor | |||
dialogNetworkFailedTitleColor | 網(wǎng)絡(luò)異常彈窗配色。 | ||
dialogNetworkFailedMsgColor | |||
dialogNetworkFailedConfirmColor | |||
dialogTooManyRetriesTitleColor | 重試過多彈框配色。 | ||
dialogTooManyRetriesMsgColor | |||
dialogTooManyRetriesConfirmColor | |||
dialogInterruptTitleColor | 驗證中斷彈窗配色。 | ||
dialogInterruptMsgColor | |||
dialogInterruptConfirmColor | |||
dialogInterruptCancelColor | |||
noticeIconPath | 業(yè)務(wù)提示圖標(biāo)路徑。 需要打開SDK對應(yīng)開關(guān)才會顯示該配置。代碼示例,請參見打開刷臉頁業(yè)務(wù)提示開關(guān)示例代碼。 | ||
noticeIconBase64 | 業(yè)務(wù)提示圖標(biāo)Base64格式。 需要打開SDK對應(yīng)開關(guān)才會顯示該配置。代碼示例,請參見打開刷臉頁業(yè)務(wù)提示開關(guān)示例代碼。 | ||
noticeTxtColor | 業(yè)務(wù)提示文案顏色。 需要打開SDK對應(yīng)開關(guān)才會顯示該配置。代碼示例,請參見打開刷臉頁業(yè)務(wù)提示開關(guān)示例代碼。 | ||
noticeBgColor | 業(yè)務(wù)提示區(qū)域背景色。 需要打開SDK對應(yīng)開關(guān)才會顯示該配置。代碼示例,請參見打開刷臉頁業(yè)務(wù)提示開關(guān)示例代碼。 |
打開刷臉頁業(yè)務(wù)提示開關(guān)示例代碼如下:
NSMutableDictionary *extParams = [NSMutableDictionary new];
[extParams setValue:self forKey:@"currentCtr"];
//如需打開刷臉頁業(yè)務(wù)提示開關(guān)(默認(rèn)可不設(shè)置),請設(shè)置此項,需要結(jié)合自定義UI的配置文件使用
[extParams setValue:@"true" forKey:ZIM_EXT_PARAMS_KEY_NEED_FACE_NOTICE];
[ZolozFaceAuthFacade verifyWith:self.certifyId extParams:extParams onCompletion:^(ZIMResponse *response) {
}];
文案自定義
目前僅支持自定義引導(dǎo)頁和活體認(rèn)證頁的展示文案。
接口說明
SDK中提供了自定義UI的接口:setCustomTxtConfig
。
/**
* 設(shè)置自定義文案
* @param customConfig
* 傳入json文件路徑或者json字符串
* @param type
* 傳入的config類型path或者json
* @param completion配置文件結(jié)果回調(diào)
* */
+ (void)setCustomLanguage:(nonnull NSString *)configuration type:(nonnull NSString *)type completion:(void(^)(BOOL success, NSError *error))completion;
參數(shù)說明
名稱
類型
說明
configuration
NSString
配置自定義入?yún)⒌念愋停?/p>
json:傳入JSON字符串。
path:傳入JSON文件的沙盒路徑。
type
NSString
根據(jù)傳入的configuration,選擇傳入json或path。
completion
block
結(jié)果信息回調(diào)。
success為YES表示設(shè)置成功。
success為NO表示設(shè)置的內(nèi)容存在問題,具體請查看對應(yīng)返回的error說明。
返回值:無。
示例代碼
//傳入文件路徑
NSString *path = @"/var/mobile/Containers/Data/Application/C9DF10E6-7AB4-4C66-A180-DF1080C93F72/Documents/customLanguage.json";
[AliyunFaceAuthFacade setCustomLanguage:path type:@"path" completion:^(BOOL success, NSError * _Nonnull error) {
NSLog(@"%@",error.localizedDescription);
}];
//傳入json字符串
NSString *jsonString = @"{""\"titleText\": \"刷臉認(rèn)證\""}";
[AliyunFaceAuthFacade setCustomLanguage:jsonString type:@"json" completion:^(BOOL success, NSError * _Nonnull error) {
NSLog(@"%@",error.localizedDescription);
}];
字段定義
字段列表
{
"guideConfig": {
"titleText": "刷臉認(rèn)證",
"agrtTopTipsText": "請先勾選協(xié)議",
"agrtAgreeText": "同意",
"agrtText": "《認(rèn)證服務(wù)協(xié)議》",
"agrtBotTipsText": "同意認(rèn)證后,將獲取您的攝像頭權(quán)限用于人臉識別驗證身份",
"startBtnText": "開始認(rèn)證",
"elderBtnText": "長輩模式認(rèn)證",
"exitBtnText": "暫不認(rèn)證",
"authPermissionSDKName": "實人認(rèn)證",
"authPermissionAPPName": "阿里云實人認(rèn)證",
"authPermissionCamera": "相機(jī)",
"authPermissionAudio": "錄音",
"authPermissionScreenEvidence": "錄屏",
"authPermissionToastTitle": "",
"authPermissionToastMsg": "",
"dialogExitTitle": "確定退出嗎?",
"dialogExitMsg": "露個臉就能通過",
"dialogExitConfirm": "確定",
"dialogExitCancel": "取消",
"dialogPermissionFailedTitle": "認(rèn)證失敗",
"dialogPermissionFailedMsg": "請確認(rèn)相關(guān)權(quán)限已開啟后再次發(fā)起",
"dialogPermissionFailedConfirm": "確認(rèn)",
"dialogNetworkFailedTitle": "網(wǎng)絡(luò)不給力",
"dialogNetworkFailedMsg": "請檢查網(wǎng)絡(luò)",
"dialogNetworkFailedConfirm": "確定",
"dialogSupportFailedTitle": "當(dāng)前系統(tǒng)不支持刷臉",
"dialogSupportFailedMsg": "刷臉僅在高版本及以上系統(tǒng)可用",
"dialogSupportFailedConfirm": "確定"
},
"faceConfig": {
"faceNotFound": "沒有檢測到臉",
"faceTooFar": "靠近一點",
"faceTooClose": "離遠(yuǎn)一點",
"faceNotIn": "把臉移入圈內(nèi)",
"badPitch": "請正對手機(jī)",
"badYaw": "請正對手機(jī)",
"faceTooMore": "請保持單人操作",
"faceIsMoving": "再清晰一點",
"faceBrightless": "臉部亮一點",
"faceBadQuality": "請露出正臉",
"eyesOnScreen": "請注視屏幕",
"blink": "眨眨眼",
"leftYaw": "向左搖頭",
"rightYaw": "向右搖頭",
"stackTime": "請保持不動",
"isBlur": "再清晰一點",
"faceInitTxt": "請正對屏幕",
"faceTitleBlink": "拿起手機(jī),眨眨眼",
"leftYawLiveness": "拿起手機(jī),向左搖頭",
"rightYawLiveness": "拿起手機(jī),向右搖頭",
"photinusCommTips": "請把臉移入圈內(nèi)保持不動",
"processing": "正在處理",
"dialogTimeOutTitle": "操作超時",
"dialogTimeOutMsg": "正對手機(jī),更容易成功",
"dialogTimeOutConfirm": "再試一次",
"dialogInterruptTitle": "驗證中斷",
"dialogInterruptConfirm": "再試一次",
"dialogInterruptCancel": "退出",
"dialogTooManyRetriesTitle": "本次操作失敗",
"dialogTooManyRetriesMsg": "刷臉失敗次數(shù)過多,請稍后再試",
"dialogTooManyRetriesConfirm": "我知道了",
"dialogExitTitle": "確定退出嗎?",
"dialogExitMsg": "露個臉就能通過",
"dialogExitConfirm": "確定",
"dialogExitCancel": "取消",
"dialogCamOpenFailedTitle": "攝像頭打開異常",
"dialogCamOpenFailedMsg": "請重啟app或手機(jī)后再次嘗試",
"dialogCamOpenFailedConfirm": "確定",
"dialogCamOpenFailedCancel": "取消",
"dialogArchSysFailedTitle": "當(dāng)前系統(tǒng)不支持刷臉",
"dialogArchSysFailedMsg": "刷臉僅在高版本及以上系統(tǒng)可用",
"dialogArchSysFailedConfirm": "確定",
"dialogSDKErrTitle": "本次操作失敗",
"dialogSDKErrMsg": "抱歉,系統(tǒng)出錯了,請再試一次",
"dialogSDKErrConfirm": "確定",
"dialogNetworkFailedTitle": "網(wǎng)絡(luò)不給力",
"dialogNetworkFailedMsg": "請檢查網(wǎng)絡(luò)",
"dialogNetworkFailedConfirm": "確定",
"verifyNotice": "您正在進(jìn)行實人認(rèn)證,請確保本人操作!"
}
}
字段詳細(xì)說明
展開折疊面板查看字段詳細(xì)說明。
自定義UI文案字段詳細(xì)說明
模塊 | key | 截圖 | 補(bǔ)充說明 |
guideConfig(引導(dǎo)頁) | titleText | 刷臉認(rèn)證文案。 | |
agrtTopTipsText | 默認(rèn)不顯示,未勾選同意,點擊開始認(rèn)證時顯示。 | ||
agrtAgreeText | 同意文案。 | ||
agrtText | 《認(rèn)證服務(wù)協(xié)議》文案。 | ||
agrtBotTipsText | 同意認(rèn)證后,……文案。 | ||
startBtnText | 開始認(rèn)證按鈕文案。 | ||
elderBtnText | 長輩模式認(rèn)證按鈕文案。 默認(rèn)不顯示,啟用適老化“選擇模式”時,顯示此按鈕。 | ||
exitBtnText | 暫不認(rèn)證文案。 | ||
rareFormNameText | 生僻字模式顯示。具體文案參見左圖示例。 | ||
rareFormIDText | |||
rareFormEntBtnText | |||
authPermissionToastTitle | 兜底權(quán)限提示toast標(biāo)題文案。 沒有注入ZIMUICustomListener或onPermissionRequest方法返回False且傳參ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST值為ZIMFacade.ZIM_EXT_PARAMS_VAL_NEED_PERMISSION_TOAST_TRUE,在請求權(quán)限時,SDK兜底顯示該提示toast。 | ||
authPermissionToastMsg | 兜底權(quán)限提示toast內(nèi)容文案。 | ||
authPermissionAPPName | 默認(rèn)兜底toast中顯示的“應(yīng)用名稱”。 為確保您能使用 | ||
authPermissionSDKName | 默認(rèn)兜底toast中顯示的“SDK名稱”。 為確保您能使用 | ||
dialogExitTitle | 手動退出彈框文案 手動點擊“X”(退出)/“暫不認(rèn)證”時。 | ||
dialogExitMsg | |||
dialogExitConfirm | |||
dialogExitCancel | |||
dialogPermissionFailedTitle | 權(quán)限拒絕彈框文案。 | ||
dialogPermissionFailedMsg | |||
dialogPermissionFailedConfirm | |||
dialogPermissionFailedCancel | |||
faceConfig(刷臉頁) |
| 刷臉頁標(biāo)題文案。 | |
| 取景框內(nèi)提示文案。 | ||
processing | 認(rèn)證提交時loading文案。 | ||
dialogInterruptTitle | 驗證中斷彈窗文案。 | ||
dialogInterruptConfirm | |||
dialogInterruptCancel | |||
dialogTooManyRetriesTitle | 重試次數(shù)過多彈窗文案。 | ||
dialogTooManyRetriesMsg | |||
dialogTooManyRetriesConfirm | |||
dialogNetworkFailedTitle | 網(wǎng)絡(luò)異常彈窗文案。 | ||
dialogNetworkFailedMsg | |||
dialogNetworkFailedConfirm | |||
dialogExitTitle | 手動退出彈窗文案。 | ||
dialogExitMsg | |||
dialogExitConfirm | |||
dialogExitCancel | |||
dialogTimeOutTitle | 操作超時彈窗文案。 | ||
dialogTimeOutMsg | |||
dialogTimeOutConfirm | |||
verifyNotice | 業(yè)務(wù)提示文案 需要打開SDK對應(yīng)開關(guān)才會顯示。代碼示例如下:
|
合規(guī)權(quán)限提醒
SDK為了保證基礎(chǔ)功能的運行需要向客戶申請對應(yīng)功能的權(quán)限,為了保證您的應(yīng)用對客戶展示合規(guī),SDK內(nèi)部提供了權(quán)限獲取以及使用說明提醒彈窗,該功能默認(rèn)關(guān)閉,當(dāng)您需要使用時請通過verify接口進(jìn)行開啟。
開關(guān)接口
接口說明
請參考對應(yīng)方案的Verify接口函數(shù)定義。
名稱 | 說明 | 類型 |
ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST | SDK獲取權(quán)限前是否彈窗 | [extParams setValue:@"true" forKey:ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST]; |
ZIM_EXT_PARAMS_KEY_PERMISSION_TOAST_DURATION | 彈窗時間 | [extParams setValue:@(3000) forKey:ZIM_EXT_PARAMS_KEY_PERMISSION_TOAST_DURATION]; |
示例代碼
NSMutableDictionary *extParams = [NSMutableDictionary dictionary];
//需要使用權(quán)限toast
[extParams setValue:@"true" forKey:ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST];
[extParams setValue:@(3000) forKey:ZIM_EXT_PARAMS_KEY_PERMISSION_TOAST_DURATION];
.....
[AliyunFaceAuthFacade verifyWith:certifyId extParams:extParams onCompletion:^(ZIMResponse *response) {
}];
彈窗自定義接口
當(dāng)SDK默認(rèn)的彈框不足以滿足業(yè)務(wù)訴求時,您可以通過DTFUICustomProtocol接口自定義彈窗能力。
接口說明
請參考對應(yīng)方案的Verify接口函數(shù)定義。
名稱 | 說明 | 類型 |
UICustomProtocol | 權(quán)限彈框自定義對象 | [extParams setValue:self forKey:@"UICustomProtocol"]; |
/**
* 實現(xiàn)Protocol方法
* @param permission,需要獲取的權(quán)限
* @param serviceType,需要獲取的權(quán)限類型
* return:BOOL類型,當(dāng)您需要自行處理彈窗時,返回YES即可,否則SDK會根據(jù)開關(guān)配置決定是否進(jìn)行彈窗
* */
- (BOOL)showPermissionViewWithPermission:(NSArray *)permission serviceType:(DTFServiceType)serviceType{
//實現(xiàn)彈窗樣式并展示
return YES;
}
參數(shù)說明
名稱
類型
說明
permission
NSArray
當(dāng)前請求權(quán)限的列表。
serviceType
String
當(dāng)前請求權(quán)限的業(yè)務(wù)。
FACE:活體業(yè)務(wù)。
OCR:證件業(yè)務(wù)。
WISH:多因子意愿業(yè)務(wù)。
返回值:bool類型。當(dāng)您需要自行處理彈窗時,返回設(shè)置YES;若需要默認(rèn)彈窗,則返回值設(shè)置NO。
示例代碼
@interface PermissionView : NSObject<DTFUICustomProtocol>
- (BOOL)showPermissionViewWithPermission:(NSArray *)permission serviceType:(DTFServiceType)serviceType;
@end
@implementation PermissionView
/**
* 實現(xiàn)Protocol方法
* @param permission
* 需要獲取的權(quán)限
* @param serviceType
* 需要獲取的權(quán)限類型
* return:BOOL類型,當(dāng)您需要自行處理彈窗時,返回YES即可,否則SDK會根據(jù)開關(guān)配置決定是否進(jìn)行彈窗
* */
- (BOOL)showPermissionViewWithPermission:(NSArray *)permission serviceType:(DTFServiceType)serviceType{
//實現(xiàn)彈窗樣式并展示
return YES;
}
@end
NSMutableDictionary *extParams = [NSMutableDictionary dictionary];
PermissionView *permissionView = [PermissionView alloc]init];
// 把實現(xiàn)了Protocol的對象傳入
[extParams setValue:permissionView forKey:@"UICustomProtocol"];
.....
[AliyunFaceAuthFacade verifyWith:certifyId extParams:extParams onCompletion:^(ZIMResponse *response) {
}];