FirebaseAppCheck Framework Reference

FIRRecaptchaProvider


@interface FIRRecaptchaProvider : NSObject <FIRAppCheckProvider>

App Check provider that verifies app integrity using reCAPTCHA Enterprise for iOS API.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;
  • Warning

    This API is a public preview and may be subject to change. The default initializer.

    Declaration

    Objective-C

    - (nullable instancetype)initWithApp:(nonnull FIRApp *)app
                                 siteKey:(nonnull NSString *)siteKey;

    Parameters

    app

    A FirebaseApp instance.

    siteKey

    The reCAPTCHA Enterprise iOS site key to be used during attestation.

    Return Value

    An instance of RecaptchaProvider if the provided FirebaseApp instance contains all required parameters.

  • Returns a new Firebase App Check token.

    Declaration

    Objective-C

    - (void)getTokenWithCompletion:(nonnull void (^)(FIRAppCheckToken *_Nullable,
                                                     NSError *_Nullable))handler;

    Parameters

    handler

    The completion handler. Make sure to call the handler with either a token or an error.

  • Returns a new Firebase App Check token. When implementing this method for your custom provider, the token returned should be suitable for consumption in a limited-use scenario. If you do not implement this method, the getTokenWithCompletion will be invoked instead whenever a limited-use token is requested.

    Declaration

    Objective-C

    - (void)getLimitedUseTokenWithCompletion:
        (nonnull void (^)(FIRAppCheckToken *_Nullable, NSError *_Nullable))handler;

    Parameters

    handler

    The completion handler. Make sure to call the handler with either a token or an error.