Android 向け SDK のカスタム UI 構成 - ID Verification - Alibaba Cloud ドキュメントセンター

ID Verification - KYC SDK for Android は、setCustomUIConfig 操作を提供します。この操作では、ファイルまたは JSON 文字列を渡すことで、Android 向け SDK の UI の色やアイコンなどのカスタム UI 構成を設定できます。 KYC は Know Your Customer の略です。このトピックでは、setCustomTxtConfig 操作を呼び出す方法とサンプルコードについて説明します。

説明

カスタム UI 構成を確実に有効にするために、操作を呼び出す前に SDK を最新バージョンに更新することをお勧めします。指定されたカスタム UI 構成が検証操作の拡張パラメータと競合する場合、カスタム UI 構成が優先されます。一貫性のある直感的なユーザーエクスペリエンスを提供するために、カスタム UI 構成が検証操作のすべてのパラメータよりも優先されるようにしてください。

概要

ID Verification - KYC SDK for Android は、カスタム UI の色とアイコンを構成できる setCustomUIConfig 操作を提供します。この操作を呼び出して、リクエストパラメータを指定することで、カスタム UI 構成を設定できます。

使用上の注意

    /**
     * @return 構成ファイルで検出されたエラー。
     * @description この操作は、カスタム UI 構成を設定するために使用されます。
     * @paramType 構成タイプ。有効な値は
     * {@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：アプリケーションアセットファイル。 paramType をこの値に設定する場合は、param をアプリケーションアセットファイルの名前に設定します。
IDTFacade.EXT_PARAMS_CONFIG_JSON：JSON 文字列。 paramType をこの値に設定する場合は、params を JSON 形式の値に設定します。

param

String

構成。 paramType の値に基づいて値を指定できます。

戻り値

戻り値。値は文字列です。SDK が param の値を解析するときにエラーまたは例外が発生した場合、メッセージが返されます。

指定されたパラメータが無効な場合は、戻り値を確認してください。

サンプルコード

// アプリケーションアセットファイルの名前を指定します。
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 構成

検証ページでカスタムフォントの色と特定のアイコンを指定できます。次のセクションでは、完全な構成例とパラメータの説明を示します。

完全な構成例

{
  "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"
  }
}

パラメータの説明

モジュール	キー	スナップショット
faceModule	faceBGColor
	exitIconBase64
	faceTitleColor
	faceTipColor
	interruptedAlertTitleColor
	中断アラートメッセージ色
	中断アラート確認色
	permissionFailedAlertTitleColor
	permissionFailedAlertメッセージ色
	権限失敗アラート確認色
	tooManyRetriesAlertTitleColor
	tooManyRetriesAlertMessageColor
	tooManyRetriesAlertConfirmColor
	faceProgressStartColor
	faceProgressEndColor
	exitAlertTitleColor
	exitAlertMessageColor
	exitAlertCancelColor
	exitAlertConfirmationColor
	timeoutAlertTitleColor
	timeoutAlertMessageColor
	timeoutAlertConfirmationColor
	verifyLoadingColor
	verifyNetworkErrorAlertTitleColor
	verifyNetworkErrorAlertメッセージ色
	ネットワークエラーアラートのキャンセル色の確認
	verifyNetworkErrorAlert確認色
ocrModule	exitIconBase64
	ocrTitleColor
	ocr境界線色
	albumBase64
	takePhotoBase64
	submitBase64
	ocrSubmitTitleColor
	ocrLoadingColor
	failedAlertTitleColor
	failedAlertMessageColor
	failedAlertCancelColor
	failedAlertConfirmationColor
	ocrNetworkErrorAlertTitleColor
	ocrNetworkErrorAlertMessage色
	ocrNetworkErrorAlertCancelColor
	ocrNetworkErrorAlertConfirm色
	権限失敗アラートタイトルの色
	権限失敗アラートメッセージ色
	権限失敗アラート確認色
	ドキュメントエラーアラートタイトルの色
	docErrorAlertメッセージ色
	ドキュメントエラーアラートのキャンセル色
	docErrorAlert確認色
	制限のアラートタイトルの色
	制限のアラートメッセージの色
	制限アラート確認色
	タイムアウトアラートタイトルの色
	timeoutAlertMessageColor
	timeoutAlertConfirmationColor
	終了アラートタイトルの色
	終了アラートのキャンセル色
	終了アラート確認色
	ocrMessageFailAlertTitleColor
	ocrMessageFailAlertCancelColor
	ocrMessageFailAlertConfirmColor
	OCR 結果終了アイコン Base64
	OCR 結果タイトルの色
	OCR 結果ヒントの背景色
	ocr結果ヒントの色
	OCR 結果情報タイトルの色
	OCR 結果情報コンテンツの色
	OCR 結果確認ボタン有効時の背景色
	OCR 結果確認ボタン有効時のタイトルの色
	OCR 結果ヒントタイトルの色
	ocrResultTipIconBase64
	ocrResultErrorTipBGColor
	ocrResultInfoborderColor
	OCR 結果確認ボタン無効時の背景色
	OCR 結果確認ボタン無効時タイトル色
	OCR 結果終了アラートタイトルの色	ocrResultConfirmBtnDisabledTitleColor
	OCR 結果終了アラートキャンセル色
	OCR 結果終了アラート確認色
	OCR 結果情報空アラートタイトルの色
	ocrResultInfoEmptyAlert確認色
	OCR 結果ネットワークエラー警告タイトルの色
	ocrResultNetworkErrorAlertメッセージ色
	ocrResultNetworkErrorAlert確認色
	ocrResultNetworkErrorAlertキャンセル色
	ocrResultInfoErrorAlertメッセージ色
	ocrResultInfoErrorAlert確認色