API reference

Verification session task delegate protocol

Callback for verification session results

After you obtain the verification result, submit it to your business server to validate the parameters.

- (void)alicomCaptchaSession:(AlicomCaptcha4Session *)captchaSession
              didReceive:(NSString *)status
                 result:(nullable NSDictionary *)result;

Callback for errors in the verification session

 (void)alicomCaptchaSession:(AlicomCaptcha4Session *)captchaSession
       didReceiveError:(AlicomC4Error *)error;

Verification session

Verification session task delegate

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

ID of the current verification session

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

Serial number of the current verification session

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

Verify the current session configuration

@property (nonnull, readonly, nonatomic, strong) AlicomCaptcha4SessionConfiguration

Create a verification session instance

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

Configure a new verification session

+ (instancetype)sessionWithCaptchaID:(NSString *)captchaID
      configuration:(nullable AlicomCaptcha4SessionConfiguration

Verification session configuration

Verification interface style

typedef NS_ENUM(NSInteger, AlicomC4UserInterfaceStyle) {
 /** Follows the system style. */
 AlicomC4UserInterfaceStyleSystem = 0,
 /** Light style. */
 AlicomC4UserInterfaceStyleLight,
 /** Dark style. */
 AlicomC4UserInterfaceStyleDark,
 /** Default style. */
 AlicomC4UserInterfaceStyleDefault = AlicomC4UserInterfaceStyleLight
}

Path for remote access to static resources

The full path for remote access to static resources. The default value is empty.

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

Protocol for remote access to static resources

The protocol for remote access to static resources. The default value is @"https".

@property (nonatomic, strong) NSString *protocol;

Interface style

The default interface theme is plain white.

@property (nonatomic, assign) AlicomC4UserInterfaceStyle userInterfaceSty;

Background color

The background color. The default value is transparent.

@property (nonatomic, strong) UIColor *backgroundColor;

Debug mode switch

The debug mode is disabled by default.

@property (nonatomic, assign) BOOL debugEnable;

Background click interaction

The background click interaction is enabled by default.

@property (nonatomic, assign) BOOL backgroundUserInteractionEnable;

Request timeout duration

The request timeout period. The default value is 8 seconds.

@property (nonatomic, assign) NSTimeInterval timeout;

Set language

By default, the language of the Captcha interface follows the system language.

@property (nonatomic, strong) NSString *language;

The supported languages and their language short codes are as follows:

Additional parameter settings

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

The supported key-value pairs are as follows:

Get default configurations

+ (AlicomCaptcha4SessionConfiguration *)defaultConfiguration;

Response example

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

Fault Description Object

/// Invalid parameter. Check the parameters that you entered.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeInvalidParameter;
/// The operation failed. For more information, see the description.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeOperationFail;
/// A resource is missing. Check whether the AlicomCaptcha4.bundle file is complete.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeMissedResource;
/// The user canceled the validation.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeUserDidCancel;
/// Failed to load the file. Check whether the complete AlicomCaptcha4.bundle file is imported or the configured remote static resources are accessible.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeLoadFileFailure;
/// Load timeout.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeTimeout;
/// Failed to execute the JavaScript script.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeEvaluatingJavascriptFail;
/// JavaScript returned an error.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeJavascriptError;
/// WebView memory warning.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeWebViewMemoryWarning;
/// An unknown error occurred.
FOUNDATION_EXPORT NSString * const AlicomC4ErrorCodeUnknown;