RecaptchaEnterprise Framework Reference

RecaptchaError

@interface RecaptchaError : NSError

Error class for reCAPTCHA Events.

• errorMessage

  Human readable error message.

  Declaration

  Swift

  var errorMessage: String? { get set }

  Objective-C

  @property (nonatomic, nullable) NSString *errorMessage;

• errorCode

  Code relative to the error that was thrown. It maps to RecaptchaErrorCode.

  Declaration

  Swift

  var errorCode: Int { get set }

  Objective-C

  @property (nonatomic) NSInteger errorCode;

• -initWithDomain:code:userInfo:message:

  Builds a new reCAPTCHA Error object.

  Declaration

  Swift

  init(domain: String, code: RecaptchaErrorCode, userInfo dict: [String : Any]? = nil, message: String?)

  Objective-C

  - (nonnull instancetype)
      initWithDomain:(nonnull NSErrorDomain)domain
                code:(RecaptchaErrorCode)code
            userInfo:(NSDictionary<NSErrorUserInfoKey, id> *_Nullable)dict
             message:(NSString *_Nullable)message;

• -init

  Undocumented

  Declaration

  Objective-C

  - (instancetype)init NS_UNAVAILABLE;

• -description

  For debug purposes, prints a human-friendly description of the error.

  Declaration

  Swift

  func description() -> String

  Objective-C

  - (nonnull NSString *)description;

Deprecated APIs and properties.

• workflowAbortedTokenKey

  If the returned error code is of type Aborted you can use this key to get the aborted token out of the userInfo property. The token is stored inside an instance of RecaptchaToken.

  Declaration

  Swift

  class var workflowAbortedTokenKey: String { get }

  Objective-C

  @property (class, nonatomic, readonly) NSString *_Nonnull workflowAbortedTokenKey;