logoDokumentation
Suchen

iOS SDK API

GTCaptcha4SessionTaskDelegate

Protokoll für Aufgaben-Delegierte der Verifizierungssitzung

gtCaptchaSession:didReceive:result:

Callback für die Ergebnisparameter der Verifizierungssitzung.

Deklaration

- (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession didReceive:(NSString *)status result:(nullable NSDictionary *)result;
              
              - (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession
              didReceive:(NSString *)status
                  result:(nullable NSDictionary *)result;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Parameter

Param Beschreibung
captchaSession Verifizierungssitzung
status Statuscode. „0“/„1“: Unvollständig/Abgeschlossen.
Wenn der Status „1“ ist, bedeutet dies Erfolg und das Ergebnis muss einer sekundären Verifizierung unterzogen werden.
result Parameter zur Verifizierung des Ergebnisses.

Erläuterung

Nachdem die Ergebnisparameter der Verifizierung empfangen wurden, müssen sie an den Business-Server übermittelt werden, um die Verifizierung der Parameter abzuschließen. Beispiel für result:

{ pass_token = "eb6d2e064524ae96ddc99a0e6e15f95dbb234008d108f0db269f27d426bcf3c6"; gen_time = "1660894030"; captcha_output = "fI9I34MDjVi10gJO_EqXwNpN8hK0rYLEPVWSDE4W6kc1umDoTHIlD_t6YQNNpPG2tJlKR8he6WFWkkllU8goGeNVNOzhqmAm256BpK8qAEHNrOjHzkNagfIcx_A21ssPrG6YlnnHFx3PfBnbrn5fb2aKDIi0I5xmCUjxq0dsFuANLIQVtllMjkJ7-1l_j-Wz"; captcha_id = "647f5ed2ed8acb4be36784e01556bb71"; lot_number = "0861c607d519469b9117d0c6dd551fe3"; }
              
              {
    pass_token = "eb6d2e064524ae96ddc99a0e6e15f95dbb234008d108f0db269f27d426bcf3c6";
    gen_time = "1660894030";
    captcha_output = "fI9I34MDjVi10gJO_EqXwNpN8hK0rYLEPVWSDE4W6kc1umDoTHIlD_t6YQNNpPG2tJlKR8he6WFWkkllU8goGeNVNOzhqmAm256BpK8qAEHNrOjHzkNagfIcx_A21ssPrG6YlnnHFx3PfBnbrn5fb2aKDIi0I5xmCUjxq0dsFuANLIQVtllMjkJ7-1l_j-Wz";
    captcha_id = "647f5ed2ed8acb4be36784e01556bb71";
    lot_number = "0861c607d519469b9117d0c6dd551fe3";
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

gtCaptchaSession:didReceiveError:

Callback für Fehler, die während der Verifizierungssitzung auftreten können.

Deklaration

- (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession didReceiveError:(GTC4Error *)error;
              
              - (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession
         didReceiveError:(GTC4Error *)error;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Parameter

Param Beschreibung
captchaSession Verifizierungssitzung
error Fehlerobjekt mit Beschreibung

Siehe auch

Fehler

GTCaptcha4Session

Verifizierungssitzung

delegate

Aufgaben-Delegierte der Verifizierungssitzung.

Deklaration

@property (nonatomic, weak) id<GTCaptcha4SessionTaskDelegate> delegate;
              
              @property (nonatomic, weak) id<GTCaptcha4SessionTaskDelegate> delegate;

            
Diesen Codeblock im schwebenden Fenster anzeigen

captchaID

Verifizierungs-ID dieser Sitzung.

Deklaration

@property (nonnull, readonly, nonatomic, strong) NSString *captchaID;
              
              @property (nonnull, readonly, nonatomic, strong) NSString *captchaID;

            
Diesen Codeblock im schwebenden Fenster anzeigen

challenge

Seriennummer dieser Verifizierungssitzung.

Deklaration

@property (nullable, readonly, nonatomic, strong) NSString *challenge;
              
              @property (nullable, readonly, nonatomic, strong) NSString *challenge;

            
Diesen Codeblock im schwebenden Fenster anzeigen

configuration

Konfiguration dieser Verifizierungssitzung.

Deklaration

@property (nonnull, readonly, nonatomic, strong) GTCaptcha4SessionConfiguration *configuration;
              
              @property (nonnull, readonly, nonatomic, strong) GTCaptcha4SessionConfiguration *configuration;

            
Diesen Codeblock im schwebenden Fenster anzeigen

sessionWithCaptchaID:

Erstellt eine neue Instanz der Verifizierungssitzung.

Deklaration

+ (instancetype)sessionWithCaptchaID:(NSString *)captchaID;
              
              + (instancetype)sessionWithCaptchaID:(NSString *)captchaID;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Parameter

Param Beschreibung
captchaID Verifizierungs-ID

Rückgabewert

Eine neue GTCaptcha4Session-Instanz

sessionWithCaptchaID:configuration:

Erstellt eine neue Instanz der Verifizierungssitzung.

Deklaration

+ (instancetype)sessionWithCaptchaID:(NSString *)captchaID configuration:(nullable GTCaptcha4SessionConfiguration *)configuration;
              
              + (instancetype)sessionWithCaptchaID:(NSString *)captchaID
                       configuration:(nullable GTCaptcha4SessionConfiguration *)configuration;

            
Diesen Codeblock im schwebenden Fenster anzeigen
Param Beschreibung
captchaID Verifizierungs-ID
configuration Sitzungskonfiguration

Rückgabewert

Eine neue GTCaptcha4Session-Instanz

initWithCaptchaID:

Erstellt eine neue Instanz der Verifizierungssitzung.

Deklaration

- (instancetype)initWithCaptchaID:(NSString *)captchaID;
              
              - (instancetype)initWithCaptchaID:(NSString *)captchaID;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Parameter

Param Beschreibung
captchaID Verifizierungs-ID

Rückgabewert

Eine neue GTCaptcha4Session-Instanz

initWithCaptchaID:configuration:

Erstellt eine neue Instanz der Verifizierungssitzung.

Deklaration

- (instancetype)initWithCaptchaID:(NSString *)captchaID configuration:(nullable GTCaptcha4SessionConfiguration *)configuration;
              
              - (instancetype)initWithCaptchaID:(NSString *)captchaID
                    configuration:(nullable GTCaptcha4SessionConfiguration *)configuration;

            
Diesen Codeblock im schwebenden Fenster anzeigen
Param Beschreibung
captchaID Verifizierungs-ID
configuration Sitzungskonfiguration

Rückgabewert

Eine neue GTCaptcha4Session-Instanz

verify

Verifizierungsvorgang starten.

Deklaration

- (void)verify;
              
              - (void)verify;

            
Diesen Codeblock im schwebenden Fenster anzeigen

cancel

Verifizierungsvorgang abbrechen.

Deklaration

- (void)cancel;
              
              - (void)cancel;

            
Diesen Codeblock im schwebenden Fenster anzeigen

sdkVersion

SDK-Versionsnummer ermitteln.

Deklaration

+ (NSString *)sdkVersion;
              
              + (NSString *)sdkVersion;

            
Diesen Codeblock im schwebenden Fenster anzeigen

GTCaptcha4SessionConfiguration

Konfiguration der Verifizierungssitzung

GTC4UserInterfaceStyle

Stil der Verifizierungsbenutzeroberfläche.

Deklaration

typedef NS_ENUM(NSInteger, GTC4UserInterfaceStyle) { /** Systemstil übernehmen */ GTC4UserInterfaceStyleSystem = 0, /** Heller Stil */ GTC4UserInterfaceStyleLight, /** Dunkler Stil */ GTC4UserInterfaceStyleDark, /** Standardstil */ GTC4UserInterfaceStyleDefault = GTC4UserInterfaceStyleLight };
              
              typedef NS_ENUM(NSInteger, GTC4UserInterfaceStyle) {
    /** Systemstil übernehmen */
    GTC4UserInterfaceStyleSystem = 0,
    /** Heller Stil */
    GTC4UserInterfaceStyleLight,
    /** Dunkler Stil */
    GTC4UserInterfaceStyleDark,
    /** Standardstil */
    GTC4UserInterfaceStyleDefault = GTC4UserInterfaceStyleLight
};

            
Diesen Codeblock im schwebenden Fenster anzeigen

resourcePath

Vollständiger Pfad für den Fernzugriff auf statische Ressourcen, Standard ist leer.

Deklaration

@property (nullable, nonatomic, strong) NSString *resourcePath;
              
              @property (nullable, nonatomic, strong) NSString *resourcePath;

            
Diesen Codeblock im schwebenden Fenster anzeigen

protocol

Protokoll für den Fernzugriff auf statische Ressourcen, Standard ist „https“.

Deklaration

@property (nonatomic, strong) NSString *protocol;
              
              @property (nonatomic, strong) NSString *protocol;

            
Diesen Codeblock im schwebenden Fenster anzeigen

userInterfaceStyle

Stil der Benutzeroberfläche und Statusleiste, Standard ist reinweiß.

Deklaration

@property (nonatomic, assign) GTC4UserInterfaceStyle userInterfaceStyle;
              
              @property (nonatomic, assign) GTC4UserInterfaceStyle userInterfaceStyle;

            
Diesen Codeblock im schwebenden Fenster anzeigen

backgroundColor

Hintergrundfarbe, Standard ist transparent.

Deklaration

@property (nonatomic, strong) UIColor *backgroundColor;
              
              @property (nonatomic, strong) UIColor *backgroundColor;

            
Diesen Codeblock im schwebenden Fenster anzeigen

debugEnable

Schalter für den Debugmodus, Standard ist deaktiviert.

Deklaration

@property (nonatomic, assign) BOOL debugEnable;
              
              @property (nonatomic, assign) BOOL debugEnable;

            
Diesen Codeblock im schwebenden Fenster anzeigen

backgroundUserInteractionEnable

Hintergrundinteraktion, Standard ist aktiviert.

Deklaration

@property (nonatomic, assign) BOOL backgroundUserInteractionEnable;
              
              @property (nonatomic, assign) BOOL backgroundUserInteractionEnable;

            
Diesen Codeblock im schwebenden Fenster anzeigen

timeout

Zeitlimit für Anfragen, Standard: 8 Sekunden.

Deklaration

@property (nonatomic, assign) NSTimeInterval timeout;
              
              @property (nonatomic, assign) NSTimeInterval timeout;

            
Diesen Codeblock im schwebenden Fenster anzeigen

language

Sprache, Standard ist systemabhängig. Für spezifische Sprachen siehe Sprachcodes.

Deklaration

@property (nonatomic, strong) NSString *language;
              
              @property (nonatomic, strong) NSString *language;

            
Diesen Codeblock im schwebenden Fenster anzeigen

supportedInterfaceOrientations

Unterstützte Ausrichtungen des Bildschirms.

Deklaration

@property (assign, nonatomic) UIInterfaceOrientationMask supportedInterfaceOrientations;
              
              @property (assign, nonatomic) UIInterfaceOrientationMask supportedInterfaceOrientations;

            
Diesen Codeblock im schwebenden Fenster anzeigen

additionalParameter

Zusätzliche Parameter, Standard ist leer. Die Parameter werden zusammengefügt und an engagelab übermittelt.

Deklaration

@property (nullable, nonatomic, strong) NSDictionary *additionalParameter;
              
              @property (nullable, nonatomic, strong) NSDictionary *additionalParameter;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Erläuterung

Die unterstützte Key-Value-Liste ist wie folgt:

Key Typ Beschreibung Standardwert
„loading“ NSString Benutzerdefinierter Ladezustandsindikator, relativer Pfad der Lade-Ressource für das WebView-Laden von HTML. Ein leerer String hebt das Laden auf. „./gt4-loading.gif“
„rem“ NSNumber Gesamtskalierungsfaktor für den Verifizierungscode. @(1)
„hideBar“ NSArray<NSString *> * Blendet die Schließen- und Aktualisieren-Schaltflächen auf nachfolgenden Verifizierungsbildschirmen aus. Mit @[@"close", @"refresh"] werden die Schließen- und Aktualisieren-Schaltflächen ausgeblendet. @[]
„nextWidth“ NSString Breite des Verifizierungscode-Popups, z. B. „300px“. nil
„riskType“ NSString Spezifiziert den Verifizierungstyp in Verbindung mit der Risiko-Kontrollintegration. nil
„hideSuccess“ NSNumber Blendet das Erfolgs-Popup der Verifizierung aus, @(0)/@(1) für nicht ausblenden oder ausblenden. @(0)

Beispielcode

#define captchaID @"1234567890abcdef" GTCaptcha4SessionConfiguration *config = [GTCaptcha4SessionConfiguration defaultConfiguration]; NSMutableDictionary *params = [@{} mutableCopy]; [params setValue:@(1.25) forKey:@"rem"]; /* 1,25-fache Skalierung */ [params setValue:@[@"close", @"refresh"] forKey:@"hideBar"]; /* Schließen- und Aktualisieren-Schaltflächen ausblenden */ [params setValue:@"300px" forKey:@"nextWidth"]; [params setValue:@"click" forKey:@"riskType"]; /* Smart Click-Verifizierung, konsistent mit Backend-Konfiguration */ [params setValue:@(1) forKey:@"hideSuccess"]; /* NSNumber für booleschen Wert verwenden */ [params setValue:@"./gt4-loading.gif" forKey:@"loading"]; config.additionalParameter = params; GTCaptcha4Session *captchaSession = [GTCaptcha4Session sessionWithCaptchaID:captchaID configuration:config]; ...
              
              #define captchaID @"1234567890abcdef"

GTCaptcha4SessionConfiguration *config = [GTCaptcha4SessionConfiguration defaultConfiguration];

NSMutableDictionary *params = [@{} mutableCopy];
[params setValue:@(1.25)                  forKey:@"rem"]; /* 1,25-fache Skalierung */
[params setValue:@[@"close", @"refresh"]  forKey:@"hideBar"]; /* Schließen- und Aktualisieren-Schaltflächen ausblenden */
[params setValue:@"300px"                 forKey:@"nextWidth"];
[params setValue:@"click"                 forKey:@"riskType"]; /* Smart Click-Verifizierung, konsistent mit Backend-Konfiguration */
[params setValue:@(1)                     forKey:@"hideSuccess"]; /* NSNumber für booleschen Wert verwenden */
[params setValue:@"./gt4-loading.gif"     forKey:@"loading"];

config.additionalParameter = params;

GTCaptcha4Session *captchaSession = [GTCaptcha4Session sessionWithCaptchaID:captchaID configuration:config];
...

            
Diesen Codeblock im schwebenden Fenster anzeigen

defaultConfiguration

Standardkonfiguration abrufen.

Deklaration

+ (GTCaptcha4SessionConfiguration *)defaultConfiguration;
              
              + (GTCaptcha4SessionConfiguration *)defaultConfiguration;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert

+ (GTCaptcha4SessionConfiguration *)defaultConfiguration { GTCaptcha4SessionConfiguration *config = [[GTCaptcha4SessionConfiguration alloc] init]; config.debugEnable = NO; config.timeout = 8.0; config.language = [GTC4Utils systemLanguage]; config.protocol = @"https"; config.userInterfaceStyle = GTC4UserInterfaceStyleDefault; config.backgroundColor = [UIColor clearColor]; config.backgroundUserInteractionEnable = YES; return config; }
              
              + (GTCaptcha4SessionConfiguration *)defaultConfiguration {
    GTCaptcha4SessionConfiguration *config = [[GTCaptcha4SessionConfiguration alloc] init];
    config.debugEnable  = NO;
    config.timeout      = 8.0;
    config.language     = [GTC4Utils systemLanguage];
    config.protocol     = @"https";
    config.userInterfaceStyle = GTC4UserInterfaceStyleDefault;
    config.backgroundColor = [UIColor clearColor];
    config.backgroundUserInteractionEnable = YES;
    
    return config;
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Fehler

Fehlerobjekt mit Beschreibung

/// Ungültiger Parameter. Bitte überprüfen Sie die Eingabeparameter. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeInvalidParameter; /// Vorgang fehlgeschlagen. Prüfen Sie die Detailbeschreibung. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeOperationFail; /// Ressource fehlt. Bitte prüfen Sie, ob die Datei GTCaptcha4.bundle vollständig ist. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeMissedResource; /// Benutzer hat die Verifizierung abgebrochen. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUserDidCancel; /// Laden der Datei fehlgeschlagen. Bitte prüfen Sie, ob die vollständige GTCaptcha4.bundle importiert wurde oder ob die konfigurierte Remote-Ressource erreichbar ist. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeLoadFileFailure; /// Ladevorgang abgelaufen. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeTimeout; /// Ausführung des Javascript-Skripts fehlgeschlagen. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeEvaluatingJavascriptFail; /// Javascript hat einen Fehler zurückgegeben. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeJavascriptError; /// WebView-Speicherwarnung. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeWebViewMemoryWarning; /// Unbekannter Fehler. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUnknown;
              
              /// Ungültiger Parameter. Bitte überprüfen Sie die Eingabeparameter.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeInvalidParameter;
/// Vorgang fehlgeschlagen. Prüfen Sie die Detailbeschreibung.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeOperationFail;
/// Ressource fehlt. Bitte prüfen Sie, ob die Datei GTCaptcha4.bundle vollständig ist.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeMissedResource;
/// Benutzer hat die Verifizierung abgebrochen.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUserDidCancel;
/// Laden der Datei fehlgeschlagen. Bitte prüfen Sie, ob die vollständige GTCaptcha4.bundle importiert wurde oder ob die konfigurierte Remote-Ressource erreichbar ist.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeLoadFileFailure;
/// Ladevorgang abgelaufen.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeTimeout;
/// Ausführung des Javascript-Skripts fehlgeschlagen.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeEvaluatingJavascriptFail;
/// Javascript hat einen Fehler zurückgegeben.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeJavascriptError;
/// WebView-Speicherwarnung.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeWebViewMemoryWarning;
/// Unbekannter Fehler.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUnknown;

            
Diesen Codeblock im schwebenden Fenster anzeigen

code

Fehlercode. Kann zum Abgleich und zur Fehlerbehandlung genutzt werden.

Deklaration

@property (readonly, nonatomic, strong) NSString *code;
              
              @property (readonly, nonatomic, strong) NSString *code;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Siehe auch

Siehe Fehlercodeliste oben.

msg

Fehlermeldung. Kann zur Anzeige in der Benutzeroberfläche genutzt werden.

Deklaration

@property (readonly, nonatomic, strong) NSString *msg;
              
              @property (readonly, nonatomic, strong) NSString *msg;

            
Diesen Codeblock im schwebenden Fenster anzeigen

desc

Detaillierte Fehlerbeschreibung. Dient der Fehlersuche im Detail.

Deklaration

@property (readonly, nonatomic, strong) NSDictionary *desc;
              
              @property (readonly, nonatomic, strong) NSDictionary *desc;

            
Diesen Codeblock im schwebenden Fenster anzeigen

Erläuterung

Kann zur Unterstützung bei betrieblichen Problemen während der Benutzerverifizierung genutzt werden.

icon
Vertrieb kontaktieren