FIRAuthRequestConfiguration.h 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. /*
  2. * Copyright 2017 Google
  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. NS_ASSUME_NONNULL_BEGIN
  19. /** @class FIRAuthRequestConfiguration
  20. @brief Defines configurations to be added to a request to Firebase Auth's backend.
  21. */
  22. @interface FIRAuthRequestConfiguration : NSObject
  23. /** @property APIKey
  24. @brief The Firebase Auth API key used in the request.
  25. */
  26. @property(nonatomic, copy, readonly) NSString *APIKey;
  27. /** @property LanguageCode
  28. @brief The language code used in the request.
  29. */
  30. @property(nonatomic, copy, nullable) NSString *languageCode;
  31. /** @property additionalFrameworkMarker
  32. @brief Additional framework marker that will be added as part of the header of every request.
  33. */
  34. @property(nonatomic, copy, nullable) NSString *additionalFrameworkMarker;
  35. /** @property emulatorHostAndPort
  36. @brief If set, the local emulator host and port to point to instead of the remote backend.
  37. */
  38. @property(nonatomic, copy, nullable) NSString *emulatorHostAndPort;
  39. - (instancetype)init NS_UNAVAILABLE;
  40. /** @fn initWithRequestClass:APIKey:authLanguage:
  41. @brief Designated initializer.
  42. @param APIKey The API key to be used in the request.
  43. */
  44. - (nullable instancetype)initWithAPIKey:(NSString *)APIKey NS_DESIGNATED_INITIALIZER;
  45. @end
  46. NS_ASSUME_NONNULL_END