No Description

FIRGitHubAuthProvider.h 1.6KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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. /**
  20. @brief A string constant identifying the GitHub identity provider.
  21. */
  22. extern NSString *const FIRGitHubAuthProviderID NS_SWIFT_NAME(GitHubAuthProviderID);
  23. /**
  24. @brief A string constant identifying the GitHub sign-in method.
  25. */
  26. extern NSString *const _Nonnull FIRGitHubAuthSignInMethod NS_SWIFT_NAME(GitHubAuthSignInMethod);
  27. /** @class FIRGitHubAuthProvider
  28. @brief Utility class for constructing GitHub credentials.
  29. */
  30. NS_SWIFT_NAME(GitHubAuthProvider)
  31. @interface FIRGitHubAuthProvider : NSObject
  32. /** @fn credentialWithToken:
  33. @brief Creates an `FIRAuthCredential` for a GitHub sign in.
  34. @param token The GitHub OAuth access token.
  35. @return A FIRAuthCredential containing the GitHub credential.
  36. */
  37. + (FIRAuthCredential *)credentialWithToken:(NSString *)token;
  38. /** @fn init
  39. @brief This class is not meant to be initialized.
  40. */
  41. - (instancetype)init NS_UNAVAILABLE;
  42. @end
  43. NS_ASSUME_NONNULL_END