FIRTOTPMultiFactorAssertion+Internal.h 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. /*
  2. * Copyright 2023 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/LICENSE2.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 <TargetConditionals.h>
  17. #if TARGET_OS_IOS
  18. #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPMultiFactorAssertion.h"
  19. #import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRTOTPSecret.h"
  20. NS_ASSUME_NONNULL_BEGIN
  21. /**
  22. @brief The subclass of base class MultiFactorAssertion, used to assert ownership of a TOTP
  23. (Time-based One Time Password). second factor.
  24. This class is available on iOS only.
  25. */
  26. @interface FIRTOTPMultiFactorAssertion ()
  27. /**
  28. @brief secret TOTPSecret
  29. */
  30. @property(nonatomic, copy, readonly, nonnull) FIRTOTPSecret *secret;
  31. /**
  32. @brief one time password string
  33. */
  34. @property(nonatomic, copy, readonly, nonnull) NSString *oneTimePassword;
  35. /**
  36. @brief the enrollment ID
  37. */
  38. @property(nonatomic, copy, readonly, nonnull) NSString *enrollmentID;
  39. /**
  40. @fn initWithSecret
  41. @brief initializing function
  42. @param secret TOTPSecret
  43. @param oneTimePassword one time password string
  44. */
  45. - (instancetype)initWithSecret:(FIRTOTPSecret *)secret oneTimePassword:(NSString *)oneTimePassword;
  46. /**
  47. @fn initWithEnrollmentID:oneTimePassword
  48. @brief initializing function
  49. @param enrollmentID enrollment ID
  50. @param oneTimePassword one time password string
  51. */
  52. - (instancetype)initWithEnrollmentID:(NSString *)enrollmentID
  53. oneTimePassword:(NSString *)oneTimePassword;
  54. @end
  55. NS_ASSUME_NONNULL_END
  56. #endif