RecaptchaEnterprise Framework Reference

RecaptchaAction

@interface RecaptchaAction : NSObject

Action intended to be protected by reCAPTCHA. This object should be passed to RecaptchaClient.execute.

• -initWithCustomAction:

  Creates an object with a custom action from a String.

  Declaration

  Swift

  init(customAction: String)

  Objective-C

  - (instancetype _Nonnull)initWithCustomAction:(NSString *_Nonnull)customAction;

• login

  Indicates that the protected action is a Login workflow.

  Declaration

  Swift

  class var login: RecaptchaAction { get }

  Objective-C

  @property (class, nonatomic, readonly) RecaptchaAction *_Nonnull login;

• signup

  Indicates that the protected action is a Signup workflow.

  Declaration

  Swift

  class var signup: RecaptchaAction { get }

  Objective-C

  @property (class, nonatomic, readonly) RecaptchaAction *_Nonnull signup;

• action

  A String representing the action.

  Declaration

  Swift

  var action: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull action;

Deprecated APIs and properties.

• actionType

  Deprecated

  RecaptchaActionType is not used.

  Action that is intended for reCAPTCHA to protect.

  Declaration

  Swift

  var actionType: RecaptchaActionType { get }

  Objective-C

  @property (nonatomic, readonly) RecaptchaActionType actionType;

• extraParameters

  Deprecated

  extraParameters is not used anywhere in the code

  Extra parameters to send during call to execute.

  Declaration

  Swift

  var extraParameters: [AnyHashable : Any]? { get }

  Objective-C

  @property (nonatomic, readonly) NSDictionary *_Nullable extraParameters;

• -initWithAction:

  Deprecated

  Use initWithCustomAction instead.

  Creates an object with a predefined reCAPTCHA action.

  Declaration

  Swift

  init(action: RecaptchaActionType)

  Objective-C

  - (instancetype _Nonnull)initWithAction:(RecaptchaActionType)action;

• customAction

  Deprecated

  Use RecaptchaAction.action instead of customAction.

  A customized action.

  Declaration

  Swift

  var customAction: String { get }

  Objective-C

  @property (nonatomic, readonly) NSString *_Nonnull customAction;

• -initWithAction:extraParameters:

  Deprecated

  Use initWithCustomAction instead.

  Creates an object with a predefined reCAPTCHA action and extra parameters.

  Declaration

  Swift

  init(action: RecaptchaActionType, extraParameters: [String : String]?)

  Objective-C

  - (instancetype _Nonnull)initWithAction:(RecaptchaActionType)action
                          extraParameters:
                              (NSDictionary<NSString *, NSString *> *_Nullable)
                                  extraParameters;

• -initWithCustomAction:extraParameters:

  Deprecated

  Use initWithCustomAction(customAction:) without extraParameters instead.

  Creates an object with a custom action from a String and extra parameters.

  Declaration

  Swift

  init(customAction: String, extraParameters: [String : String]?)

  Objective-C

  - (instancetype _Nonnull)
      initWithCustomAction:(NSString *_Nonnull)customAction
           extraParameters:
               (NSDictionary<NSString *, NSString *> *_Nullable)extraParameters;