# RecaptchaEnterprise Framework Reference

# RecaptchaAction

    @interface RecaptchaAction : NSObject

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


  ### [-initWithCustomAction:](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(im)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](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(cpy)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](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(cpy)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](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(py)action)


  ` A String representing the action.

  #### Declaration

  Swift

      var action: String { get }

  Objective-C

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

[## Deprecated APIs and properties.](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/Deprecated-APIs-and-properties.)

- `


  ### [actionType](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(py)actionType)


  ` Deprecated

  RecaptchaActionType is not used.
  Action that is intended for reCAPTCHA to protect.

  #### Declaration

  Swift

      var actionType: https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Enums/RecaptchaActionType.html { get }

  Objective-C

      @property (nonatomic, readonly) https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Enums/RecaptchaActionType.html actionType;

- `


  ### [extraParameters](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(py)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:](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(im)initWithAction:)


  ` Deprecated

  Use initWithCustomAction instead.
  Creates an object with a predefined reCAPTCHA action.

  #### Declaration

  Swift

      init(action: https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Enums/RecaptchaActionType.html)

  Objective-C

      - (instancetype _Nonnull)initWithAction:(https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Enums/RecaptchaActionType.html)action;

- `


  ### [customAction](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(py)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:](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(im)initWithAction:extraParameters:)


  ` Deprecated

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

  #### Declaration

  Swift

      init(action: https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Enums/RecaptchaActionType.html, extraParameters: [String : String]?)

  Objective-C

      - (instancetype _Nonnull)initWithAction:(https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Enums/RecaptchaActionType.html)action
                              extraParameters:
                                  (NSDictionary<NSString *, NSString *> *_Nullable)
                                      https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction.html#/c:objc(cs)RecaptchaAction(py)extraParameters;

- `


  ### [-initWithCustomAction:extraParameters:](https://docs.cloud.google.com/recaptcha/docs/reference/ios/client/api/Classes/RecaptchaAction#/c:objc(cs)RecaptchaAction(im)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;