logoDocumentation
Rechercher

API SDK iOS

GTCaptcha4SessionTaskDelegate

Protocole du délégué de la tâche de session de vérification

gtCaptchaSession:didReceive:result:

Callback pour les paramètres de résultat de la session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres

Param Description
captchaSession Session de vérification
status Code d'état. @"0"/@"1" : Incomplet/Complet.
Quand le statut est @"1", cela indique un succès, et le résultat nécessite une vérification secondaire.
result Paramètres de vérification du résultat.

Discussion

Après avoir obtenu les paramètres de résultat de la vérification, ils doivent être soumis au serveur métier pour compléter la vérification des paramètres. Exemple de 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";
}

            
Afficher ce bloc de code dans la fenêtre flottante

gtCaptchaSession:didReceiveError:

Callback pour les erreurs survenant lors de la session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres

Param Description
captchaSession Session de vérification
error Objet de description de l'erreur

Voir aussi

Erreur

GTCaptcha4Session

Session de vérification

delegate

Délégué de la tâche de session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

captchaID

ID de vérification de la session en cours.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

challenge

Numéro de série de la session de vérification en cours.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

configuration

Configuration de la session de vérification en cours.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

sessionWithCaptchaID:

Créer une nouvelle instance de session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres

Param Description
captchaID ID de vérification

Valeur de retour

Une nouvelle instance de GTCaptcha4Session

sessionWithCaptchaID:configuration:

Créer une nouvelle instance de session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante
Param Description
captchaID ID de vérification
configuration Configuration de la session

Valeur de retour

Une nouvelle instance de GTCaptcha4Session

initWithCaptchaID:

Créer une nouvelle instance de session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres

Param Description
captchaID ID de vérification

Valeur de retour

Une nouvelle instance de GTCaptcha4Session

initWithCaptchaID:configuration:

Créer une nouvelle instance de session de vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante
Param Description
captchaID ID de vérification
configuration Configuration de la session

Valeur de retour

Une nouvelle instance de GTCaptcha4Session

verify

Démarrer la vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

cancel

Annuler la vérification.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

sdkVersion

Obtenir le numéro de version du SDK.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

GTCaptcha4SessionConfiguration

Configuration de la session de vérification

GTC4UserInterfaceStyle

Style d'interface de vérification.

Déclaration

typedef NS_ENUM(NSInteger, GTC4UserInterfaceStyle) { /** Suivre le style du système */ GTC4UserInterfaceStyleSystem = 0, /** Style clair */ GTC4UserInterfaceStyleLight, /** Style sombre */ GTC4UserInterfaceStyleDark, /** Style par défaut */ GTC4UserInterfaceStyleDefault = GTC4UserInterfaceStyleLight };
              
              typedef NS_ENUM(NSInteger, GTC4UserInterfaceStyle) {
    /** Suivre le style du système */
    GTC4UserInterfaceStyleSystem = 0,
    /** Style clair */
    GTC4UserInterfaceStyleLight,
    /** Style sombre */
    GTC4UserInterfaceStyleDark,
    /** Style par défaut */
    GTC4UserInterfaceStyleDefault = GTC4UserInterfaceStyleLight
};

            
Afficher ce bloc de code dans la fenêtre flottante

resourcePath

Chemin complet d'accès à distance aux ressources statiques, par défaut vide.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

protocol

Protocole utilisé pour l'accès à distance aux ressources statiques, par défaut @"https".

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

userInterfaceStyle

Style de l'interface et de la barre d'état, par défaut blanc uni.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

backgroundColor

Couleur d'arrière-plan, par défaut transparente.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

debugEnable

Interrupteur du mode debug, par défaut désactivé.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

backgroundUserInteractionEnable

Interaction avec l'arrière-plan, activée par défaut.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

timeout

Durée du délai d'attente de la requête, par défaut 8 secondes.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

language

Langue, par défaut suit le système. Pour les langues spécifiques, se référer aux codes courts de langue.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

supportedInterfaceOrientations

Orientations d'écran prises en charge.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

additionalParameter

Paramètres supplémentaires, par défaut vide. Les paramètres seront assemblés et soumis à EngageLab.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Discussion

La liste des clés-valeurs prises en charge est la suivante :

Clé Type Description Valeur par défaut
@"loading" NSString Indicateur d'état de chargement personnalisé, chemin relatif de la ressource de chargement pour le chargement html dans WebView. Mettre une chaîne vide annule le chargement. @"./gt4-loading.gif"
@"rem" NSNumber Définit le ratio d'échelle global du code de vérification. @(1)
@"hideBar" NSArray<NSString *> * Masquer le bouton de fermeture et le bouton de rafraîchissement sur les écrans de vérification suivants. Mettre @[@"close", @"refresh"] masque les boutons fermer et rafraîchir. @[]
@"nextWidth" NSString Largeur de la popup du code de vérification, avec unités telles que @"300px". nil
@"riskType" NSString Spécifie le type de vérification en association avec l'intégration de contrôle de risque. nil
@"hideSuccess" NSNumber Masquer la popup de succès de vérification, @(0)/@(1) pour ne pas masquer ou masquer. @(0)

Exemple de code

#define captchaID @"1234567890abcdef" GTCaptcha4SessionConfiguration *config = [GTCaptcha4SessionConfiguration defaultConfiguration]; NSMutableDictionary *params = [@{} mutableCopy]; [params setValue:@(1.25) forKey:@"rem"]; // Agrandir de 1,25 fois [params setValue:@[@"close", @"refresh"] forKey:@"hideBar"]; // Masquer les boutons fermer et rafraîchir [params setValue:@"300px" forKey:@"nextWidth"]; [params setValue:@"click" forKey:@"riskType"]; // Spécifier la vérification intelligente par clic, cohérent avec la configuration backend [params setValue:@(1) forKey:@"hideSuccess"]; // Utiliser NSNumber pour représenter la valeur booléenne [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"]; // Agrandir de 1,25 fois
[params setValue:@[@"close", @"refresh"]  forKey:@"hideBar"]; // Masquer les boutons fermer et rafraîchir
[params setValue:@"300px"                 forKey:@"nextWidth"];
[params setValue:@"click"                 forKey:@"riskType"]; // Spécifier la vérification intelligente par clic, cohérent avec la configuration backend
[params setValue:@(1)                     forKey:@"hideSuccess"]; // Utiliser NSNumber pour représenter la valeur booléenne
[params setValue:@"./gt4-loading.gif"     forKey:@"loading"];

config.additionalParameter = params;

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

            
Afficher ce bloc de code dans la fenêtre flottante

defaultConfiguration

Obtenir une configuration par défaut.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Valeur de retour

+ (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;
}

            
Afficher ce bloc de code dans la fenêtre flottante

Erreur

Objet de description de l'erreur

/// Paramètre invalide. Veuillez vérifier les paramètres d'entrée. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeInvalidParameter; /// Échec de l'opération. Vérifiez la description détaillée. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeOperationFail; /// Ressource manquante. Veuillez vérifier si le fichier GTCaptcha4.bundle est complet. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeMissedResource; /// L'utilisateur a annulé la vérification. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUserDidCancel; /// Échec du chargement du fichier. Veuillez vérifier si le fichier GTCaptcha4.bundle complet est importé ou si la ressource statique distante configurée est accessible. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeLoadFileFailure; /// Délai d'attente dépassé lors du chargement. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeTimeout; /// Échec de l'exécution du script Javascript. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeEvaluatingJavascriptFail; /// Javascript a retourné une erreur. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeJavascriptError; /// Avertissement de mémoire WebView. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeWebViewMemoryWarning; /// Erreur inconnue. FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUnknown;
              
              /// Paramètre invalide. Veuillez vérifier les paramètres d'entrée.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeInvalidParameter;
/// Échec de l'opération. Vérifiez la description détaillée.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeOperationFail;
/// Ressource manquante. Veuillez vérifier si le fichier GTCaptcha4.bundle est complet.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeMissedResource;

/// L'utilisateur a annulé la vérification.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUserDidCancel;

/// Échec du chargement du fichier. Veuillez vérifier si le fichier GTCaptcha4.bundle complet est importé ou si la ressource statique distante configurée est accessible.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeLoadFileFailure;
/// Délai d'attente dépassé lors du chargement.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeTimeout;
/// Échec de l'exécution du script Javascript.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeEvaluatingJavascriptFail;
/// Javascript a retourné une erreur.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeJavascriptError;
/// Avertissement de mémoire WebView.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeWebViewMemoryWarning;

/// Erreur inconnue.
FOUNDATION_EXPORT NSString * const GTC4ErrorCodeUnknown;

            
Afficher ce bloc de code dans la fenêtre flottante

code

Code d'erreur. Peut être utilisé pour la correspondance et la gestion.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Voir aussi

Se référer à la liste des codes d'erreur ci-dessus.

msg

Message d'erreur. Peut être utilisé pour l'affichage dans l'interface utilisateur.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

desc

Description détaillée de l'erreur. Utilisée pour un dépannage approfondi.

Déclaration

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

            
Afficher ce bloc de code dans la fenêtre flottante

Discussion

Peut être utilisé pour supporter les problèmes opérationnels lors de la vérification utilisateur.

icon
Contactez-nous