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