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;
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";
}
gtCaptchaSession:didReceiveError:
Callback für Fehler, die während der Verifizierungssitzung auftreten können.
Deklaration
- (void)gtCaptchaSession:(GTCaptcha4Session *)captchaSession
didReceiveError:(GTC4Error *)error;
Parameter
| Param | Beschreibung |
|---|---|
| captchaSession | Verifizierungssitzung |
| error | Fehlerobjekt mit Beschreibung |
Siehe auch
GTCaptcha4Session
Verifizierungssitzung
delegate
Aufgaben-Delegierte der Verifizierungssitzung.
Deklaration
@property (nonatomic, weak) id<GTCaptcha4SessionTaskDelegate> delegate;
captchaID
Verifizierungs-ID dieser Sitzung.
Deklaration
@property (nonnull, readonly, nonatomic, strong) NSString *captchaID;
challenge
Seriennummer dieser Verifizierungssitzung.
Deklaration
@property (nullable, readonly, nonatomic, strong) NSString *challenge;
configuration
Konfiguration dieser Verifizierungssitzung.
Deklaration
@property (nonnull, readonly, nonatomic, strong) GTCaptcha4SessionConfiguration *configuration;
sessionWithCaptchaID:
Erstellt eine neue Instanz der Verifizierungssitzung.
Deklaration
+ (instancetype)sessionWithCaptchaID:(NSString *)captchaID;
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;
| 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;
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;
| Param | Beschreibung |
|---|---|
| captchaID | Verifizierungs-ID |
| configuration | Sitzungskonfiguration |
Rückgabewert
Eine neue GTCaptcha4Session-Instanz
verify
Verifizierungsvorgang starten.
Deklaration
- (void)verify;
cancel
Verifizierungsvorgang abbrechen.
Deklaration
- (void)cancel;
sdkVersion
SDK-Versionsnummer ermitteln.
Deklaration
+ (NSString *)sdkVersion;
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
};
resourcePath
Vollständiger Pfad für den Fernzugriff auf statische Ressourcen, Standard ist leer.
Deklaration
@property (nullable, nonatomic, strong) NSString *resourcePath;
protocol
Protokoll für den Fernzugriff auf statische Ressourcen, Standard ist „https“.
Deklaration
@property (nonatomic, strong) NSString *protocol;
userInterfaceStyle
Stil der Benutzeroberfläche und Statusleiste, Standard ist reinweiß.
Deklaration
@property (nonatomic, assign) GTC4UserInterfaceStyle userInterfaceStyle;
backgroundColor
Hintergrundfarbe, Standard ist transparent.
Deklaration
@property (nonatomic, strong) UIColor *backgroundColor;
debugEnable
Schalter für den Debugmodus, Standard ist deaktiviert.
Deklaration
@property (nonatomic, assign) BOOL debugEnable;
backgroundUserInteractionEnable
Hintergrundinteraktion, Standard ist aktiviert.
Deklaration
@property (nonatomic, assign) BOOL backgroundUserInteractionEnable;
timeout
Zeitlimit für Anfragen, Standard: 8 Sekunden.
Deklaration
@property (nonatomic, assign) NSTimeInterval timeout;
language
Sprache, Standard ist systemabhängig. Für spezifische Sprachen siehe Sprachcodes.
Deklaration
@property (nonatomic, strong) NSString *language;
supportedInterfaceOrientations
Unterstützte Ausrichtungen des Bildschirms.
Deklaration
@property (assign, nonatomic) UIInterfaceOrientationMask supportedInterfaceOrientations;
additionalParameter
Zusätzliche Parameter, Standard ist leer. Die Parameter werden zusammengefügt und an engagelab übermittelt.
Deklaration
@property (nullable, nonatomic, strong) NSDictionary *additionalParameter;
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];
...
defaultConfiguration
Standardkonfiguration abrufen.
Deklaration
+ (GTCaptcha4SessionConfiguration *)defaultConfiguration;
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;
}
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;
code
Fehlercode. Kann zum Abgleich und zur Fehlerbehandlung genutzt werden.
Deklaration
@property (readonly, nonatomic, strong) NSString *code;
Siehe auch
Siehe Fehlercodeliste oben.
msg
Fehlermeldung. Kann zur Anzeige in der Benutzeroberfläche genutzt werden.
Deklaration
@property (readonly, nonatomic, strong) NSString *msg;
desc
Detaillierte Fehlerbeschreibung. Dient der Fehlersuche im Detail.
Deklaration
@property (readonly, nonatomic, strong) NSDictionary *desc;
Erläuterung
Kann zur Unterstützung bei betrieblichen Problemen während der Benutzerverifizierung genutzt werden.

