FIRGetRecaptchaConfigRequest.h 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. /*
  2. * Copyright 2022 Google LLC
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. #import "FirebaseAuth/Sources/Backend/FIRAuthRPCRequest.h"
  18. #import "FirebaseAuth/Sources/Backend/FIRIdentityToolkitRequest.h"
  19. NS_ASSUME_NONNULL_BEGIN
  20. /** @class FIRGetRecaptchaConfigRequest
  21. @brief Represents the parameters for the getRecaptchaConfig endpoint.
  22. */
  23. @interface FIRGetRecaptchaConfigRequest : FIRIdentityToolkitRequest <FIRAuthRPCRequest>
  24. /** @property clientType
  25. @brief The client type should always be "ios".
  26. */
  27. @property(nonatomic, copy, nullable) NSString *clientType;
  28. /** @property version
  29. @brief The version of the reCAPTCHA service should be always be "enterprise".
  30. */
  31. @property(nonatomic, copy, nullable) NSString *version;
  32. /** @fn initWithEndpoint:requestConfiguration:
  33. @brief Please use initWithClientType:version:requestConfiguration:
  34. */
  35. - (nullable instancetype)initWithEndpoint:(NSString *)endpoint
  36. requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
  37. NS_UNAVAILABLE;
  38. /** @fn initWithEmail:password:requestConfiguration:
  39. @brief Designated initializer.
  40. @param clientType The client type.
  41. @param version The version of the reCAPTCHA service.
  42. @param requestConfiguration The config.
  43. */
  44. - (nullable instancetype)initWithClientType:(NSString *)clientType
  45. version:(NSString *)version
  46. requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
  47. NS_DESIGNATED_INITIALIZER;
  48. @end
  49. NS_ASSUME_NONNULL_END