本文由簡體中文內容自動轉碼而成。阿里雲不保證此自動轉碼的準確性、完整性及時效性。本文内容請以簡體中文版本為準。
首頁ID VerificationID Verification- KYCID Verification- KYC開發參考自訂SDK UIAndroid SDK UI自訂配置說明
搜尋幫助內容

Android SDK UI自訂配置說明

更新時間：2024-10-28 20:09
社區

ID Verification- KYC Android SDK提供自訂UI顏色、icon表徵圖的介面，開發人員可以通過編寫自訂UI配置，以檔案或JSON資料格式通過傳入setCustomUIConfig介面實現UI的自訂效果。本文為您介紹UI自訂介面說明以及相關的程式碼範例。

說明

部分自訂配置可能需要依賴SDK升級，建議您在使用之前將SDK升級至最新版本。如使用者介面自訂設定與驗證介面的擴充參數存在衝突，優先使用使用者介面自訂設定。請確保 UI 自訂設定優先於任何驗證介面參數，以提供一致且直觀的使用者體驗。

介面說明

Android SDK中提供了自訂UI顏色和icon表徵圖的介面：setCustomUIConfig。您可以通過調用此方法並傳入對應參數來實現自訂UI的效果。

介面定義

 
    /**
     * @return 設定檔檢測出的異常資訊。
     * @description 此介面用於設定自訂UI。
     * @paramType paramType 參數類型{@link IDTFacade} ，可傳範圍
     * {@link IDTFacade.EXT_PARAMS_CONFIG_JSON} | {@link IDTFacade.EXT_PARAMS_CONFIG_ASSETS_NAME}）。
     *
     * @params {@link String} params 參數值，與paramType相對應的值。
     */
    public String setCustomUIConfig(@IDTFacade int paramType, String param) {
     ...
    }

參數說明

名稱

類型

說明

名稱

類型

說明

paramType

int

配置自訂入參的類型，可選值：

  • IDTFacade.EXT_PARAMS_CONFIG_ASSETS_NAME：App assets檔案類型，param傳入assets檔案名稱。

  • IDTFacade.EXT_PARAMS_CONFIG_JSON：JSON字串，params傳入JSON格式資料。

param

String

根據paramType取值傳入相應資料。

傳回值

String類型，當SDK對param內容解析遇到錯誤或出現異常資訊時會通過提示資訊的方式返回。

當配置參數無效時，請重點關注傳回值資訊。

範例程式碼

//傳入assets檔案名稱
String fileName = "DTFCustomUIConfig.json";
int paramType = IDTFacade.EXT_PARAMS_CONFIG_ASSETS_NAME;
String customUIErrMsg =  IdentityPlatform.getInstance().setCustomUIConfig(paramType, fileName);

//傳入JSON字串
String jsonConfig = "<JSON格式的自訂UI配置>";
int paramType = IDTFacade.EXT_PARAMS_CONFIG_JSON;
String customUIErrMsg =  IdentityPlatform.getInstance().setCustomUIConfig(paramType, jsonConfig);

自訂UI配置內容

自訂UI目前允許使用者自訂認證頁面的字型顏色和部分Icon。完整樣本和欄位的詳細說明如下：

完整配置樣本

 
{
  "faceConfig": {
    "exitIconBase64": "exit_icon_base64",
    "faceBGColor": "#FFFFFF",
    "faceTitleColor": "#000000",
    "faceTipColor": "#000000",
    "opFailedTitleColor": "#000000",
    "opFailedTipColor": "#000000",
    "opFailedConfirmColor": "#4FA3EC",
    "facePrgressStartColor":"#dfe6eb",
    "faceProgressEndColor": "#FF6A00",
    "exitAlertTitleColor": "#000000",
    "exitAlertMessageColor": "#000000",
    "exitAlertCancelColor": "#4FA3EC",
    "exitAlertConfirmationColor": "#4FA3EC",
    "timeoutAlertTitleColor": "#000000",
    "timeoutAlertMessageColor": "#000000",
    "timeoutAlertConfirmationColor": "#4FA3EC",
    "tooManyRetriesAlertTitleColor": "#000000",
    "tooManyRetriesAlertMessageColor": "#000000",
    "tooManyRetriesAlertConfirmColor": "#4FA3EC",
    "interruptedAlertTitleColor": "#000000",
    "interruptedAlertMessageColor": "#000000",
    "interruptedAlertConfirmColor": "#4FA3EC",
    "permissionFailedAlertTitleColor": "#000000",
    "permissionFailedAlertMessageColor": "#000000",
    "permissionFailedAlertConfirmColor": "#4FA3EC",
    "verifyNetworkErrorAlertTitleColor": "#000000",
    "verifyNetworkErrorAlertMessageColor": "#000000",
    "verifyNetworkErrorAlertConfirmColor": "#4FA3EC",
    "verifyNetworkErrorAlertCancelColor": "#4FA3EC",
    "verifyLoadingColor": "#585858"
  },
  "ocrConfig": {
    "exitIconBase64": "exit_icon_base64",
    "albumBase64": "album_base64",
    "takePhotoBase64": "take_photo_base64",
    "submitBase64": "submit_base64",
    "ocrResultExitIconBase64": "ocr_result_exit_icon_base64",
    "ocrResultTipIconBase64": "ocr_result_tip_icon_base64",
    "ocrTitleColor": "#FFFFFF",
    "ocrBorderColor": "#E3824C",
    "ocrSubmitTitleColor": "#FFFFFF",
    "ocrLoadingColor": "#FFFFFF",
    "failedAlertTitleColor": "#000000",
    "failedAlertMessageColor": "#000000",
    "failedAlertCancelColor": "#4FA3EC",
    "failedAlertConfirmationColor": "#4FA3EC",
    "timeoutAlertTitleColor": "#000000",
    "timeoutAlertMessageColor": "#000000",
    "timeoutAlertConfirmationColor": "#4FA3EC",
    "exitAlertTitleColor": "#000000",
    "exitAlertCancelColor": "#4FA3EC",
    "exitAlertConfirmationColor": "#4FA3EC",
    "ocrResultTitleColor": "#000000",
    "ocrResultTipBGColor": "#DFDFDF",
    "ocrResultTipColor": "#000000",
    "ocrResultInfoTitleColor": "#000000",
    "ocrResultInfoContentColor": "#F6F6F6",
    "ocrResultInfoBorderColor": "#E3824C",
    "ocrResultTipTitleColor": "#D59F9E",
    "ocrResultErrorTipBGColor": "#F6DAD5",
    "ocrResultConfirmBtnDisabledBGColor": "#DADADA",
    "ocrResultConfirmBtnDisabledTitleColor": "#FFFFFF",
    "ocrResultConfirmBtnEnabledBGColor": "",
    "ocrResultConfirmBtnEnabledTitleColor": "#FFFFFF",
    "ocrResultExitAlertTitleColor": "#000000",
    "ocrResultExitAlertCancelColor": "#000000",
    "ocrResultExitAlertConfirmationColor": "#4FA3EC",
    "restrictionsAlertTitleColor": "#000000",
    "restrictionsAlertMessageColor": "#000000",
    "restrictionsAlertConfirmationColor": "#4FA3EC",
    "permissionFailedAlertTitleColor": "#000000",
    "permissionFailedAlertMessageColor": "#000000",
    "permissionFailedAlertConfirmColor": "#4FA3EC",
    "ocrNetworkErrorAlertTitleColor": "#000000",
    "ocrNetworkErrorAlertMessageColor": "#000000",
    "ocrNetworkErrorAlertCancelColor": "#4FA3EC",
    "ocrNetworkErrorAlertConfirmColor": "#4FA3EC",
    "docErrorAlertTitleColor": "#000000",
    "docErrorAlertMessageColor": "#000000",
    "docErrorAlertCancelColor": "#4FA3EC",
    "docErrorAlertConfirmColor": "#4FA3EC",
    "ocrResultNetworkErrorAlertTitleColor": "#000000",
    "ocrResultNetworkErrorAlertMessageColor": "#000000",
    "ocrResultNetworkErrorAlertConfirmColor": "#4FA3EC",
    "ocrResultNetworkErrorAlertCancelColor":"#000000",
    "ocrResultInfoErrorAlertMessageColor": "#000000",
    "ocrResultInfoErrorAlertConfirmColor": "#4FA3EC",
    "ocrResultInfoEmptyAlertTitleColor":"#000000",
    "ocrResultInfoEmptyAlertConfirmColor":"#FF6A00",
    "ocrMessageFailAlertTitleColor":"#FF0000",
    "ocrMessageFailAlertCancelColor": "#FFFF00",
    "ocrMessageFailAlertConfirmColor":"#FF33FF"
  }
}

配置欄位詳細說明

模組

key

截圖

faceModule

faceBGColor

image.png

exitIconBase64

image.png

faceTitleColor

image.png

faceTipColor

image.png

interruptedAlertTitleColor

image.png

interruptedAlertMessageColor

image.png

interruptedAlertConfirmColor

image.png

permissionFailedAlertTitleColor

image.png

permissionFailedAlertMessageColor

image.png

permissionFailedAlertConfirmColor

image.png

tooManyRetriesAlertTitleColor

image.png

tooManyRetriesAlertMessageColor

image.png

tooManyRetriesAlertConfirmColor

image.png

faceProgressStartColor

image.png

faceProgressEndColor

image.png

exitAlertTitleColor

image.png

exitAlertMessageColor

image.png

exitAlertCancelColor

image.png

exitAlertConfirmationColor

image.png

timeoutAlertTitleColor

image.png

timeoutAlertMessageColor

image.png

timeoutAlertConfirmationColor

image.png

verifyLoadingColor

image.png

verifyNetworkErrorAlertTitleColor

image.png

verifyNetworkErrorAlertMessageColor

image.png

verifyNetworkErrorAlertCancelColor

image.png

verifyNetworkErrorAlertConfirmColor

image.png

ocrModule

exitIconBase64

image.png

ocrTitleColor

image.png

ocrBorderColor

image.png

albumBase64

image.png

takePhotoBase64

image.png

submitBase64

image.png

ocrSubmitTitleColor

image.png

ocrLoadingColor

image.png

failedAlertTitleColor

image.png

failedAlertMessageColor

image.png

failedAlertCancelColor

image.png

failedAlertConfirmationColor

image.png

ocrNetworkErrorAlertTitleColor

image.png

ocrNetworkErrorAlertMessageColor

image.png

ocrNetworkErrorAlertCancelColor

image.png

ocrNetworkErrorAlertConfirmColor

image.png

permissionFailedAlertTitleColor

image.png

permissionFailedAlertMessageColor

image.png

permissionFailedAlertConfirmColor

image.png

docErrorAlertTitleColor

image.png

docErrorAlertMessageColor

image.png

docErrorAlertCancelColor

image.png

docErrorAlertConfirmColor

image.png

restrictionsAlertTitleColor

image.png

restrictionsAlertMessageColor

image.png

restrictionsAlertConfirmationColor

image.png

timeoutAlertTitleColor

image.png

timeoutAlertMessageColor

image.png

timeoutAlertConfirmationColor

image.png

exitAlertTitleColor

image.png

exitAlertCancelColor

image.png

exitAlertConfirmationColor

image.png

ocrMessageFailAlertTitleColor

image.png

ocrMessageFailAlertCancelColor

image.png

ocrMessageFailAlertConfirmColor

image.png

ocrResultExitIconBase64

image.png

ocrResultTitleColor

image.png

ocrResultTipBGColor

image.png

ocrResultTipColor

image.png

ocrResultInfoTitleColor

image.png

ocrResultInfoContentColor

image.png

ocrResultConfirmBtnEnabledBGColor

image.png

ocrResultConfirmBtnEnabledTitleColo

image.png

ocrResultTipTitleColor

image.png

ocrResultTipIconBase64

image.png

ocrResultErrorTipBGColor

image.png

ocrResultInfoborderColor

image.png

ocrResultConfirmBtnDisabledBGColor

image.png

ocrResultConfirmBtnDisabledTitleColor

image.png

ocrResultExitAlertTitleColor

ocrResultConfirmBtnDisabledTitleColor

ocrResultExitAlertCancelColor

image.png

ocrResultExitAlertConfirmationColor

image.png

ocrResultInfoEmptyAlertTitleColor

image.png

ocrResultInfoEmptyAlertConfirmColor

image.png

ocrResultNetworkErrorAlertTitleColor

image.png

ocrResultNetworkErrorAlertMessageColor

image.png

ocrResultNetworkErrorAlertConfirmColor

image.png

ocrResultNetworkErrorAlertCancleColor

image.png

ocrResultInfoErrorAlertMessageColor

image.png

ocrResultInfoErrorAlertConfirmColor

image.png

上一篇：自訂SDK UI下一篇：iOS SDK UI自訂配置說明
  • 本頁導讀 （M）
  • 介面說明
  • 介面定義
  • 參數說明
  • 傳回值
  • 範例程式碼
  • 自訂UI配置內容
  • 完整配置樣本
  • 配置欄位詳細說明
文檔反饋
phone 聯絡我們

立即和Alibaba Cloud在線服務人員進行交談，獲取您想了解的產品信息以及最新折扣。

alicare alicarealicarealicare