Android SDK API

Externe Utility-Klasse für Support

Methoden

getClient(Context)

Gibt das Utility-Objekt GTCaptcha4Client zurück

Deklaration

              
              public static GTCaptcha4Client getClient(Context context)

            

Parameter

Achtung

Dies ist keine Singleton-Implementierung. Das über getClient() erhaltene GTCaptcha4Client-Objekt muss gespeichert werden, um es beispielsweise in onDestroy oder anderen Lebenszyklus-Methoden weiterzuverwenden.

init(String)

Initialisierung mit Standardkonfiguration

Deklaration

              
              public GTCaptcha4Client init(String captchaId)

            

Parameter

Achtung

Der Aufruf der init()-Methode startet sofort den Ladevorgang des Captchas. Wird sie vor dem Lebenszyklusereignis onResume() aufgerufen, wird das Captcha vorab geladen. Beim Ausführen von verifyWithCaptcha() wird das Captcha dann schnell geladen und angezeigt. Das gilt auch für die folgenden Methoden.

init(String, GTCaptcha4Config)

Initialisierung mit benutzerdefinierter Konfiguration

Deklaration

              
              public GTCaptcha4Client init(String captchaId, GTCaptcha4Config config)

            

Parameter

addOnSuccessListener(GTCaptcha4Client.OnSuccessListener)

Fügt einen Listener für das Verifikationsergebnis hinzu, der aufgerufen wird, wenn das Captcha erfolgreich geladen und von Nutzer:innen gelöst wurde.

Deklaration

              
              public GTCaptcha4Client addOnSuccessListener(GTCaptcha4Client.OnSuccessListener response)

            

Parameter

addOnFailureListener(GTCaptcha4Client.OnFailureListener)

Fügt einen Listener für das Laden des Captchas hinzu, der ausgelöst wird, wenn beim Laden des Captchas ein Fehler auftritt.

Deklaration

              
              public GTCaptcha4Client addOnFailureListener(GTCaptcha4Client.OnFailureListener listener)

            

Parameter

addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener)

Fügt einen Listener für das erfolgreiche Laden der Frontend-Verifikation hinzu. Sobald das Frontend erfolgreich geladen wurde, wird der Callback ausgelöst. Bei abgeschlossenem Preloading erfolgt der Callback unmittelbar nach dem Aufruf von verifyWithCaptcha.

Deklaration

              
              public GTCaptcha4Client addOnWebViewShowListener(GTCaptcha4Client.OnWebViewShowListener listener)

            

Parameter

verifyWithCaptcha()

Startet den Verifikationsprozess und lädt das Captcha.

Deklaration

              
              public GTCaptcha4Client verifyWithCaptcha()

            

Achtung

Vor dem Aufruf von verifyWithCaptcha() müssen init(), addOnSuccessListener() und addOnFailureListener() aufgerufen werden, da sonst Fehler auftreten können.

cancel()

Bricht die Verifikation ab und schließt das Verifikationsfenster.

Deklaration

              
              public void cancel()

            

Achtung

Vor dem Aufruf von cancel() müssen init(), addOnSuccessListener() und addOnFailureListener() aufgerufen werden, da sonst Fehler auftreten können.

setLogEnable(boolean enable)

Aktiviert oder deaktiviert das Log-Monitoring.

Deklaration

              
              public void setLogEnable(boolean enable)

            

Hinweis

Mit setLogEnable kann die Log-Ausgabe gesteuert werden.

destroy()

Gibt Ressourcen mit langer Lebensdauer frei.

Deklaration

              
              public void destroy()

            

Hinweis

Verifikationsressourcen werden freigegeben. Diese Methode muss aufgerufen werden.

Hinweis

Diese Methode sollte im onDestroy-Lebenszyklus der vom Client genutzten Captcha-Oberfläche aufgerufen werden.

configurationChanged(Configuration)

Behandelt Änderungen der Bildschirmausrichtung.

Deklaration

              
              public void configurationChanged(Configuration newConfig)

            

Hinweis

Diese Methode sollte im Lebenszyklus-Callback onConfigurationChanged bei Änderungen der Bildschirmausrichtung aufgerufen werden.

getVersion()

Gibt die Versionsnummer zurück.

Deklaration

              
              public static String getVersion()

            

Rückgabewert

Gibt die Versionsnummer als String zurück.

isSupportWebView(Context)

Prüft, ob das System WebView unterstützt. Falls nicht, sollte eine Fallback-Logik verwendet werden.

Deklaration

              
              public static Pair<Boolean, String> isSupportWebView(Context context)

            

Rückgabewert

Beschreibung des Pair-Objekts:

GTCaptcha4Config#Builder

Parameter-Konfigurationsklasse

setTimeOut(int)

Setzt die Timeout-Dauer für Anfragen.

Deklaration

              
              public Builder setTimeOut(int timeOut)

            

Parameter

setResourcePath(String)

Setzt den Ressourcenpfad für das Laden der WebView.

Deklaration

              
              public Builder setResourcePath(String html)

            

Parameter

Hinweis

Standardmäßig wird die Datei gt4-index*.html im assets-Verzeichnis geladen. Diese Schnittstelle muss nur bei speziellen Anforderungen gesetzt werden.

setLanguage(String)

Setzt die Sprache für die Übertragung an JS. Diese Einstellung steuert nur die Sprache der geladenen WebView, die Sprache des SDK richtet sich nach der aktuellen App.

Deklaration

              
              public Builder setLanguage(String language)

            

Parameter

Hinweis

Wird null gesetzt oder nicht konfiguriert, wird der Standard-Sprachcode der App an das Frontend übertragen.

setCanceledOnTouchOutside(boolean)

Legt fest, ob ein Klick auf den grauen Bereich den Dialog schließt. Standardmäßig wird geschlossen.

Deklaration

              
              public Builder setCanceledOnTouchOutside(boolean canceledOnTouchOutside)

            

Parameter

setDebug(boolean)

Legt fest, ob sich die Anwendung im Debug-Modus befindet. Für den Produktivbetrieb muss false gesetzt oder nicht konfiguriert werden.

Deklaration

              
              public Builder setDebug(boolean debug)

            

Parameter

setBackgroundColor(int)

Setzt die Hintergrundfarbe der WebView. Dies steuert die Hintergrundfarbe der Android-WebView-Komponente und unterscheidet sich von der Hintergrundfarbe des Frontend-JS.

Deklaration

              
              public Builder setBackgroundColor(int backgroundColor)

            

Parameter

setDialogStyle(String)

Setzt den Theme-Stil des Verifikationsdialogs.

Deklaration

              
              public Builder setDialogStyle(String dialogStyle)

            

Parameter

Standard-Theme-Stil:

              
              <style name="gt4_captcha_dialog_style" parent="android:Theme.Dialog">
    <!-- Kein Fensterrahmen für den Dialog -->
    <item name="android:windowFrame">@null</item>
    <!-- Schwebend über der Activity -->
    <item name="android:windowIsFloating">true</item>
    <!-- Transparenz -->
    <item name="android:windowIsTranslucent">true</item>
    <!-- Kein Titel -->
    <item name="android:windowNoTitle">true</item>
    <item name="android:windowContentOverlay">@null</item>
    <!-- Schwarzer, transparenter Hintergrund außerhalb des Dialogs -->
    <item name="android:backgroundDimEnabled">true</item>
    <!-- Hintergrund des Dialogs -->
    <item name="android:windowBackground">@android:color/transparent</item>
    <item name="android:padding">0dp</item>
</style>

            

setDialogShowListener(GTCaptcha4Client.OnDialogShowListener)

Setzt den Listener-Callback für das Anzeigen des Verifikationsfensters.

Deklaration

              
              public void setDialogShowListener(GTCaptcha4Client.OnDialogShowListener dialogShowListener)

            

Parameter

setParams(Map<String, Object>)

Konfiguriert zusätzliche Parameter, die vollständig an JS übergeben werden.

Deklaration

              
              public Builder setParams(Map<String, Object> params)

            

Parameter

Hinweis

Unterstützte Schlüssel-Wert-Paare:

Beispielcode

              
              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()

Erstellt ein GTCaptcha4Config-Objekt zur Verwendung mit der init()-Schnittstelle.

Deklaration

              
              public GTCaptcha4Config build()

            

GTCaptcha4Client#OnSuccessListener

Callback-Listener für das Verifikationsergebnis.

onSuccess(Boolean, String)

Callback der Verifikationsschnittstelle.

Deklaration

              
              void onSuccess(Boolean status, String response)

            

Parameter

Hinweis

Beschreibung erfolgreicher Verifikation:

              
              {"lot_number":"b150e61198924eff9eaae121e9b67aa8","pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4","gen_time":"1622020720","captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="}

            

Beschreibung fehlgeschlagener Verifikation:

              
              {"captchaId":"647f5ed2ed8acb4be36784e01556bb71","captchaType":"slide","challenge":"95ed53b4-95c6-4c6b-9aac-769b29ef74a0"}

            

GTCaptcha4Client#OnFailureListener

Callback-Listener für Ladefehler.

onFailure(String)

Callback bei Ladefehler.

Deklaration

              
              void onFailure(String error)

            

Parameter

Hinweis

Beschreibung eines Ladefehlers:

              
               {"code":"-14460","msg":"Verification session has been canceled","desc":{"description":"User cancelled 'Captcha'"}}

            

GTCaptcha4Client#OnWebViewShowListener

Callback-Listener für erfolgreiches Frontend-Laden der Verifikation.

onWebViewShow()

Erfolgreiches Laden der Frontend-Verifikation.

Deklaration

              
              void onWebViewShow()

            

Hinweis

Callback nach erfolgreichem Laden der Frontend-Verifikation. Bei abgeschlossenem Preloading wird dieser Callback direkt nach dem Aufruf von verifyWithCaptcha ausgelöst.

GTCaptcha4Client#OnDialogShowListener

Callback-Listener für das Anzeigen des Verifikationsfensters.

actionBeforeDialogShow(Dialog)

Callback vor dem Anzeigen des Verifikationsfensters.

Deklaration

              
              void actionBeforeDialogShow(Dialog dialog)

            

Parameter

actionAfterDialogShow()

Callback nach dem Anzeigen des Verifikationsfensters.

Deklaration

              
              void actionAfterDialogShow(Dialog dialog)

            

Parameter

Hinweis

Hier können Sie Systemstile ändern, z. B. Navigationsleiste oder Statusleiste ausblenden.

onDialogFocusChanged()

Callback bei Fokusänderung des Verifikationsfensters.

Deklaration

              
              void onDialogFocusChanged(Dialog dialog, boolean hasFocus)

            

Parameter