Android SDK API
外部サポートユーティリティクラス
メソッド
getClient(Context)
GTCaptcha4Clientユーティリティクラスオブジェクトを取得します。
宣言
public static GTCaptcha4Client getClient(Context context)
public static GTCaptcha4Client getClient(Context context)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| context | context | コンテキスト |
ディスカッション
注意: これはシングルトン実装ではありません。getClient()を通じて取得したGTCaptcha4Clientオブジェクトは、onDestroyや他のライフサイクルメソッドで使用するために保存する必要があります。
init(String)
デフォルト設定で初期化します。
宣言
public GTCaptcha4Client init(String captchaId)
public GTCaptcha4Client init(String captchaId)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| captchaId | String | バックエンドから適用されたCaptcha ID |
ディスカッション
注意: init()メソッドを呼び出した後、キャプチャの読み込み操作が実行されます。onResume()ライフサイクルの前に呼び出された場合、キャプチャがプリロードされます。verifyWithCaptcha()を実行してキャプチャを表示する際、迅速に読み込んで表示されます。以下も同様です。
init(String, GTCaptcha4Config)
カスタム設定で初期化します。
宣言
public GTCaptcha4Client init(String captchaId, GTCaptcha4Config config)
public GTCaptcha4Client init(String captchaId, GTCaptcha4Config config)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| captchaId | String | バックエンドから適用されたCaptcha ID |
| config | GTCaptcha4Config | 設定オブジェクト |
addOnSuccessListener(GTCaptcha4Client.OnSuccessListener)
検証結果のリスナーを追加します。キャプチャが正常に読み込まれ、ユーザーがキャプチャを完了した際にコールバックされます。
宣言
public GTCaptcha4Client addOnSuccessListener(GTCaptcha4Client.OnSuccessListener response)
public GTCaptcha4Client addOnSuccessListener(GTCaptcha4Client.OnSuccessListener response)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| response | GTCaptcha4Client.OnSuccessListener | 検証結果のリスナー |
addOnFailureListener(GTCaptcha4Client.OnFailureListener)
キャプチャ読み込み失敗時のリスナーを追加します。キャプチャ読み込み中にエラーが発生した際にトリガーされます。
宣言
public GTCaptcha4Client addOnFailureListener(GTCaptcha4Client.OnFailureListener listener)
public GTCaptcha4Client addOnFailureListener(GTCaptcha4Client.OnFailureListener listener)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| listener | GTCaptcha4Client.OnFailureListener | キャプチャ読み込み失敗時のリスナー |
addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener)
フロントエンドキャプチャ読み込み成功時のリスナーを追加します。フロントエンドキャプチャが正常に読み込まれると、コールバックがトリガーされます。プリロードが完了している場合、verifyWithCaptchaを呼び出した直後にコールバックがトリガーされます。
宣言
public GTCaptcha4Client addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener listener)
public GTCaptcha4Client addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener listener)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| listener | GTCaptcha4Client.OnWebViewShowListener | フロントエンドキャプチャ読み込み成功時のリスナー |
verifyWithCaptcha()
検証プロセスを開始し、キャプチャを読み込みます。
宣言
public GTCaptcha4Client verifyWithCaptcha()
public GTCaptcha4Client verifyWithCaptcha()
このコードブロックはフローティングウィンドウ内に表示されます
ディスカッション
注意: verifyWithCaptcha()を呼び出す前に、init()、addOnSuccessListener()、addOnFailureListener()を呼び出す必要があります。そうしないとエラーが発生する可能性があります。
cancel()
検証をキャンセルし、検証ウィンドウを閉じます。
宣言
public void cancel()
public void cancel()
このコードブロックはフローティングウィンドウ内に表示されます
ディスカッション
注意: cancel()を呼び出す前に、init()、addOnSuccessListener()、addOnFailureListener()を呼び出す必要があります。そうしないとエラーが発生する可能性があります。
setLogEnable(boolean enable)
ログ監視を有効または無効にします。
宣言
public void setLogEnable(boolean enable)
public void setLogEnable(boolean enable)
このコードブロックはフローティングウィンドウ内に表示されます
ディスカッション
setLogEnableを呼び出すことで、ログ出力機能を制御します。
destroy()
長期間使用されるリソースを破棄します。
宣言
public void destroy()
public void destroy()
このコードブロックはフローティングウィンドウ内に表示されます
ディスカッション
検証リソースを破棄します。このメソッドを呼び出すことが重要です。
ディスカッション
このメソッドは、クライアントが使用するキャプチャインターフェースのonDestroyライフサイクルで呼び出す必要があります。
configurationChanged(Configuration)
画面の向きの変更を処理します。
宣言
public void configurationChanged(Configuration newConfig)
public void configurationChanged(Configuration newConfig)
このコードブロックはフローティングウィンドウ内に表示されます
ディスカッション
このメソッドは、画面の向きが変更された際のonConfigurationChangedライフサイクルメソッドで呼び出す必要があります。
getVersion()
バージョン番号を取得します。
宣言
public static String getVersion()
public static String getVersion()
このコードブロックはフローティングウィンドウ内に表示されます
戻り値
バージョン番号をStringとして返します。
isSupportWebView(Context)
システムがWebViewをサポートしているかを確認します。サポートされていない場合はフォールバックロジックを推奨します。
宣言
public static Pair<Boolean, String> isSupportWebView(Context context)
public static Pair<Boolean, String> isSupportWebView(Context context)
このコードブロックはフローティングウィンドウ内に表示されます
戻り値
Pairオブジェクトの詳細:
| パラメータ | 型 | 説明 |
|---|---|---|
| first | Boolean | WebViewがサポートされているかどうか。サポートされていない場合はフォールバックロジックを使用できます。 |
| second | String | WebViewオブジェクトの読み込みエラーの説明 |
GTCaptcha4Config#Builder
設定パラメータクラス。
setTimeOut(int)
リクエストのタイムアウトを設定します。
宣言
public Builder setTimeOut(int timeOut)
public Builder setTimeOut(int timeOut)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| timeOut | int | タイムアウト時間（ミリ秒）、デフォルトは10000 |
setResourcePath(String)
WebView読み込み用のリソースパスを設定します。
宣言
public Builder setResourcePath(String html)
public Builder setResourcePath(String html)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| html | String | WebView読み込みパス |
ディスカッション
デフォルトでは、assetsディレクトリ内のgt4-index*.htmlファイルを読み込みます。特別な要件がない限り、このインターフェースを設定する必要はありません。
setLanguage(String)
JS送信用の言語を設定します。このインターフェースは、読み込まれるWebViewの言語のみを制御します。SDKの言語は現在のアプリケーションに従います。
宣言
public Builder setLanguage(String language)
public Builder setLanguage(String language)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| language | String | サポートされているフロントエンド言語の略コード。詳細はフロントエンドドキュメントを参照してください。 |
ディスカッション
nullに設定するか設定しない場合、アプリケーションのデフォルト言語略コードがフロントエンドに送信されます。
setCanceledOnTouchOutside(boolean)
グレーエリアをクリックした際にダイアログを閉じるかどうかを設定します。デフォルトでは閉じます。
宣言
public Builder setCanceledOnTouchOutside(boolean canceledOnTouchOutside)
public Builder setCanceledOnTouchOutside(boolean canceledOnTouchOutside)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| canceledOnTouchOutside | boolean | trueの場合、閉じます |
setDebug(boolean)
debugモードであるかどうかを設定します。本番環境に移行する前にfalseに設定するか、設定を行わないようにしてください。
宣言
public Builder setDebug(boolean debug)
public Builder setDebug(boolean debug)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| debug | boolean | trueでdebugモード、デフォルトはfalse |
setBackgroundColor(int)
WebViewの背景色を設定します。これはAndroid WebViewコンポーネントの背景色を制御します。フロントエンドのJS背景色とは異なります。
宣言
public Builder setBackgroundColor(int backgroundColor)
public Builder setBackgroundColor(int backgroundColor)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| backgroundColor | int | 色リソースアドレスまたはColor.parseColor()の戻り値 |
setDialogStyle(String)
キャプチャダイアログのテーマスタイルを設定します。
宣言
public Builder setDialogStyle(String dialogStyle)
public Builder setDialogStyle(String dialogStyle)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| dialogStyle | String | ダイアログテーマスタイルの名前 |
宣言
デフォルトのテーマスタイルは以下の通りです:
<style name="gt4_captcha_dialog_style" parent="android:Theme.Dialog">
<!--Dialog windowFrame is null-->
<item name="android:windowFrame">@null</item>
<!--Floating above activity-->
<item name="android:windowIsFloating">true</item>
<!--Translucent-->
<item name="android:windowIsTranslucent">true</item>
<!--No title-->
<item name="android:windowNoTitle">true</item>
<item name="android:windowContentOverlay">@null</item>
<!--Black translucent background outside display area-->
<item name="android:backgroundDimEnabled">true</item>
<!--Dialog background-->
<item name="android:windowBackground">@android:color/transparent</item>
<item name="android:padding">0dp</item>
</style>
<style name="gt4_captcha_dialog_style" parent="android:Theme.Dialog">
<!--Dialog windowFrame is null-->
<item name="android:windowFrame">@null</item>
<!--Floating above activity-->
<item name="android:windowIsFloating">true</item>
<!--Translucent-->
<item name="android:windowIsTranslucent">true</item>
<!--No title-->
<item name="android:windowNoTitle">true</item>
<item name="android:windowContentOverlay">@null</item>
<!--Black translucent background outside display area-->
<item name="android:backgroundDimEnabled">true</item>
<!--Dialog background-->
<item name="android:windowBackground">@android:color/transparent</item>
<item name="android:padding">0dp</item>
</style>
このコードブロックはフローティングウィンドウ内に表示されます
setDialogShowListener(GTCaptcha4Client.OnDialogShowListener)
検証ウィンドウ表示のリスナーコールバックを設定します。
宣言
public void setDialogShowListener(GTCaptcha4Client.OnDialogShowListener dialogShowListener)
public void setDialogShowListener(GTCaptcha4Client.OnDialogShowListener dialogShowListener)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| dialogShowListener | GTCaptcha4Client.OnDialogShowListener | 検証ウィンドウ表示用リスナーオブジェクト |
setParams(Map<String, Object>)
追加のパラメータ設定。このパラメータはすべてJSに送信されます。
宣言
public Builder setParams(Map<String, Object> params)
public Builder setParams(Map<String, Object> params)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| params | JSONObject | 追加設定パラメータ |
ディスカッション
サポートされているキーと値のペアは以下の通りです:
| キー | 値の型 | 説明 | デフォルト値 |
|---|---|---|---|
| displayMode | int | テーマスタイル, 0: システムに従う, 1: 通常, 2: ダーク | 0 |
| protocol | String | プロトコルヘッダー, "https://またはhttp://をサポート |
https:// |
| bgColor | String | 検証背景マスク色, CSSルールに従う。注意: 最後の2桁は透明度 | #00000000 |
| loading | String | カスタムローディング, WebViewがHTMLを読み込む際のローディングリソースの相対パス。空文字列はローディング効果をキャンセル。 | "/gt4-loading.gif" |
| rem | float | キャプチャ全体のスケーリング比率を設定 | 1 |
| hideBar | JSONArray | 次回の検証インターフェースで閉じるボタンと更新ボタンを非表示 | N/A |
| nextWidth | String | キャプチャポップアップの幅, 単位を含める必要がある, 例: "300px" | N/A |
| riskType | String | リスク制御と組み合わせた検証フォームを指定 | N/A |
| hideSuccess | boolean | 検証成功ポップアップを非表示 | FALSE |
サンプルコード
Map<String, Object> params = new HashMap<>();
params.put("displayMode", 0);
params.put("protocol", "https://");
params.put("bgColor", "#CC0000FF");
params.put("loading", "./loading_test.gif");
params.put("rem", 0.6);
JSONArray hideBar = new JSONArray()
.put("close")
.put("refresh");
params.put("hideBar", hideBar);
params.put("nextWidth", "300px");
params.put("hideSuccess", true);
GTCaptcha4Config.Builder builder = new GTCaptcha4Config.Builder()
.setParams(params);
Map<String, Object> params = new HashMap<>();
params.put("displayMode", 0);
params.put("protocol", "https://");
params.put("bgColor", "#CC0000FF");
params.put("loading", "./loading_test.gif");
params.put("rem", 0.6);
JSONArray hideBar = new JSONArray()
.put("close")
.put("refresh");
params.put("hideBar", hideBar);
params.put("nextWidth", "300px");
params.put("hideSuccess", true);
GTCaptcha4Config.Builder builder = new GTCaptcha4Config.Builder()
.setParams(params);
このコードブロックはフローティングウィンドウ内に表示されます
build()
init()インターフェースで使用するためのGTCaptcha4Configオブジェクトを構築します。
宣言
public GTCaptcha4Config build()
public GTCaptcha4Config build()
このコードブロックはフローティングウィンドウ内に表示されます
GTCaptcha4Client#OnSuccessListener
検証結果コールバックリスナークラス。
onSuccess(Boolean, String)
検証インターフェースのコールバック。
宣言
void onSuccess(Boolean status, String response)
void onSuccess(Boolean status, String response)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| status | Boolean | ユーザー操作の検証結果, trueは成功, falseは失敗。失敗時は検証スタイルを更新します。 |
| response | String | ユーザー操作の検証が成功した場合、responseデータをサーバーに送信して検証する必要があります。 |
ディスカッション
検証成功時の説明例:
{"lot_number":"b150e61198924eff9eaae121e9b67aa8","pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4","gen_time":"1622020720","captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="}
{"lot_number":"b150e61198924eff9eaae121e9b67aa8","pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4","gen_time":"1622020720","captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="}
このコードブロックはフローティングウィンドウ内に表示されます
検証失敗時の説明例:
{"captchaId":"647f5ed2ed8acb4be36784e01556bb71","captchaType":"slide","challenge":"95ed53b4-95c6-4c6b-9aac-769b29ef74a0"}
{"captchaId":"647f5ed2ed8acb4be36784e01556bb71","captchaType":"slide","challenge":"95ed53b4-95c6-4c6b-9aac-769b29ef74a0"}
このコードブロックはフローティングウィンドウ内に表示されます
GTCaptcha4Client#OnFailureListener
読み込み失敗コールバックリスナークラス。
onFailure(String)
読み込み失敗コールバック。
宣言
void onFailure(String error)
void onFailure(String error)
このコードブロックはフローティングウィンドウ内に表示されます
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| error | String | キャプチャ読み込み失敗の説明。注意: ユーザーによるキャンセルも含まれます。 |
ディスカッション
読み込み失敗時の説明例:
{"code":"-14460","msg":"Captcha session has been canceled","desc":{"description":"User cancelled 'Captcha'"}}
{"code":"-14460","msg":"Captcha session has been canceled","desc":{"description":"User cancelled 'Captcha'"}}
このコードブロックはフローティングウィンドウ内に表示されます
GTCaptcha4Client#OnWebViewShowListener
フロントエンドキャプチャ読み込み成功コールバックリスナークラス。
onWebViewShow()
フロントエンドキャプチャ読み込み成功。
宣言
void onWebViewShow()
void onWebViewShow()
このコードブロックはフローティングウィンドウ内に表示されます
ディスカッション
フロントエンドキャプチャが正常に
