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.

62 lines
2.3 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. @class FIRAuthCredential;
  18. NS_ASSUME_NONNULL_BEGIN
  19. /** @class FIROAuthProvider
  20. @brief A concrete implementation of `FIRAuthProvider` for generic OAuth Providers.
  21. */
  22. NS_SWIFT_NAME(OAuthProvider)
  23. @interface FIROAuthProvider : NSObject
  24. /** @fn credentialWithProviderID:IDToken:accessToken:
  25. @brief Creates an `FIRAuthCredential` for that OAuth 2 provider identified by providerID, ID
  26. token and access token.
  27. @param providerID The provider ID associated with the Auth credential being created.
  28. @param IDToken The IDToken associated with the Auth credential being created.
  29. @param accessToken The accessstoken associated with the Auth credential be created, if
  30. available.
  31. @return A FIRAuthCredential for the specified provider ID, ID token and access token.
  32. */
  33. + (FIRAuthCredential *)credentialWithProviderID:(NSString *)providerID
  34. IDToken:(NSString *)IDToken
  35. accessToken:(nullable NSString *)accessToken;
  36. /** @fn credentialWithProviderID:accessToken:
  37. @brief Creates an `FIRAuthCredential` for that OAuth 2 provider identified by providerID using
  38. an ID token.
  39. @param providerID The provider ID associated with the Auth credential being created.
  40. @param accessToken The accessstoken associated with the Auth credential be created
  41. @return A FIRAuthCredential.
  42. */
  43. + (FIRAuthCredential *)credentialWithProviderID:(NSString *)providerID
  44. accessToken:(NSString *)accessToken;
  45. /** @fn init
  46. @brief This class is not meant to be initialized.
  47. */
  48. - (instancetype)init NS_UNAVAILABLE;
  49. @end
  50. NS_ASSUME_NONNULL_END