You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

66 lines
1.9 KiB

6 years ago
  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 "FIRAuthRequestConfiguration.h"
  18. @class FIRAuthRequestConfiguration;
  19. NS_ASSUME_NONNULL_BEGIN
  20. /** @class FIRIdentityToolkitRequest
  21. @brief Represents a request to an identity toolkit endpoint.
  22. */
  23. @interface FIRIdentityToolkitRequest : NSObject
  24. /** @property endpoint
  25. @brief Gets the RPC's endpoint.
  26. */
  27. @property(nonatomic, copy, readonly) NSString *endpoint;
  28. /** @property APIKey
  29. @brief Gets the client's API key used for the request.
  30. */
  31. @property(nonatomic, copy, readonly) NSString *APIKey;
  32. /** @fn init
  33. @brief Please use initWithEndpoint:APIKey:
  34. */
  35. - (instancetype)init NS_UNAVAILABLE;
  36. /** @fn initWithEndpoint:APIKey:
  37. @brief Designated initializer.
  38. @param endpoint The endpoint name.
  39. @param requestConfiguration An object containing configurations to be added to the request.
  40. */
  41. - (nullable instancetype)initWithEndpoint:(NSString *)endpoint
  42. requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
  43. NS_DESIGNATED_INITIALIZER;
  44. /** @fn requestURL
  45. @brief Gets the request's full URL.
  46. */
  47. - (NSURL *)requestURL;
  48. /** @fn requestConfiguration
  49. @brief Gets the request's configuration.
  50. */
  51. - (FIRAuthRequestConfiguration *)requestConfiguration;
  52. @end
  53. NS_ASSUME_NONNULL_END