tencent cloud

/// Night mode option
typedef enum : NSUInteger {
    /// Default
    TencentCaptchaOptionsDarkModeDefault,
    /// Turn on with the system
    TencentCaptchaOptionsDarkModeTrue,
    /// Always off
    TencentCaptchaOptionsDarkModeFalse,
    /// Force open
    TencentCaptchaOptionsDarkModeForce,
} TencentCaptchaOptionsDarkMode;

typedef enum : NSUInteger {
    TencentCaptchaOptionsSwitchDefault,
    TencentCaptchaOptionsSwitchOn,
    TencentCaptchaOptionsSwitchOff,
} TencentCaptchaOptionsSwitch;

/// Captcha Request Parameters
@interface TencentCaptchaOptions : NSObject

/// Custom pass-through parameters. The business can use this field to transmit a small amount of data. The content of this field will be entered into the object of the callback.
@property (nonatomic, strong, nullable) NSString *bizState;

/// Night mode
@property (nonatomic, assign) TencentCaptchaOptionsDarkMode darkModeEnabled;

/// Help button switch
@property (nonatomic, assign) TencentCaptchaOptionsSwitch needsFeedback;

/// Custom URLs of the help button
/// @discussion If `customFeedbackURL` is not empty, the `needsFeedback` option is unavailable, the help button is always displayed, and it navigates to this URL when clicked.
@property (nonatomic, strong, nullable) NSString *customFeedbackURL;

/// Specify the language of the Captcha prompt copy. The priority is higher than the console configuration.
@property (nonatomic, strong, nullable) NSString *userLanguage;

/// Aging adaptation mode
@property (nonatomic, assign) TencentCaptchaOptionsSwitch agedEnabled;

/// Define the display method of the Captcha
/// @discussion popup (default): Display the Captcha in a centered popup floating layer form. 
@property (nonatomic, strong, nullable) NSString *type;

/// Whether to show a loading box during the Captcha loading process
@property (nonatomic, assign) TencentCaptchaOptionsSwitch loadingEnabled;

/// CaptchaAppId encrypted validation string
/// @discussion See https://www.tencentcloud.com/zh/document/product/1159/49680?lang=zh&pg=#captchaAppid
@property (nonatomic, copy, nullable) NSString *encryptedAppID;


/// Set additional parameters
/// @param value Parameter value
/// @param name Keyword name of the parameter
/// @discussion When the parameter corresponding to name does not exist, a new value will be inserted. If it exists, the new value will overwrite the old one; when value is nil, this parameter will be deleted.
- (void)setExtractParameter:(nullable id)value forName:(nonnull NSString *)name;

/// Additional parameters currently set
@property (nonatomic, strong, readonly, nonnull) NSDictionary<NSString *, id> *extractParameters;

@end


/// Captcha Service Configuration
/// - Use in `+[TencentCaptcha setupWithConfigurationHandler:]` to configure the service
/// - SeeAlso:
///     - Objective C: `+[TencentCaptcha setupWithConfigurationHandler:]`,
///     - Swift: `TencentCaptcha.setup(configurationHandler:)`
@interface TencentCaptchaConfiguration : NSObject
 
- (nonnull instancetype)init NS_UNAVAILABLE;
 
@property (nonnull, nonatomic, copy) NSString *appID;
 
 
/// Tars server address
/// - Note: If the purpose is unclear, do not set
@property (nullable, nonatomic, copy) NSURL *tarsServerURL;
 
/// Set the Host for the Captcha page
/// - Note:
///     - can only set the host part in the URL, such as the host part in `https://host/path/to/html`, other parts currently do not support modification
///     - If the host is invalid and causes the correct page URL to be unable to generate, the setting is invalid
///     - Set to nil to keep the default value
///     - If the purpose is unclear, do not set
@property (nullable, nonatomic, copy) NSString *captchaPageHost;
 
/// Whether using a cached token is allowed to speed up the request process
/// - Note: Defaults to YES. The cache policy meets needs in most scenarios. If you need special attention to real-time risk, set to NO.
@property (nonatomic, assign) BOOL usesCacheToken;

/// [Disabled, unified usage timeout] 
/// Request timeout duration for local device risk detection, in seconds
@property (nonatomic, assign) NSTimeInterval timeoutForNativeRequest__attribute__((deprecated("NOT WORK! Use 'timeout' instead.")));

/// [Disabled, unified usage timeout] 
/// Collection timeout duration for local device risk detection, in seconds
@property (nonatomic, assign) NSTimeInterval timeoutForNativePacking__attribute__((deprecated("NOT WORK! Use 'timeout' instead.")));

/// [Disabled, unified usage timeout]
/// Page loading timeout duration, in seconds
@property (nonatomic, assign) NSTimeInterval timeoutForWebViewLoading__attribute__((deprecated("NOT WORK! Use 'timeout' instead.")));

/// Unify timeout settings, in seconds. Internal stages perform timeout control allocation to simplify setting logic.
@property (nonatomic, assign) NSTimeInterval timeout;
 
@end


/// The implementation class of the Captcha service
@interface TencentCaptcha : NSObject
- (nonnull instancetype)init NS_UNAVAILABLE;
/// The singleton of the Captcha service
+ (nonnull instancetype)sharedService NS_SWIFT_NAME(shared());
/// Configuration service options
/// - Parameter configurationHandler: To modify the configuration, change the properties in the configuration provided in this callback function
- (void)setupWithConfigurationHandler:(nonnull void(^)(TencentCaptchaConfiguration *_Nonnull))configurationHandler NS_SWIFT_NAME(setup(configurationHandler:));
/// Request Captcha
/// - Parameters:
///   - webView: The web view used to display the Captcha
///   - options: Captcha request parameters
///   - completionHandler: Completion callback for verification
///
/// @discussion Due to some system limitations, the SDK cannot currently receive WKWebView generated from StoryBoard.
- (void)requestCaptchaWithWebView:(nonnull WKWebView *)webView options:(nullable TencentCaptchaOptions *)options withCompletionHandler:(nonnull void(^)(NSError *_Nullable error, NSDictionary *_Nullable result))completionHandler NS_SWIFT_NAME(requestCaptcha(withWebView:options:withCompletionHandler:));

/// Set additional parameters
/// @param value Parameter value
/// @param name Keyword name of the parameter
/// @discussion When the parameter corresponding to name does not exist, a new value will be inserted. If it exists, the new value will overwrite the old one; when value is nil, this parameter will be deleted.
- (void)setExtractParameter:(nullable id)value forName:(nonnull NSString *)name;

/// Additional parameters currently set
@property (nonatomic, strong, readonly, nonnull) NSDictionary<NSString *, id> *extractParameters;

@end