GithubAuthProvider class

Поставщик для создания OAuthCredential для ProviderId .ГИХАБ.

GitHub требует перенаправления OAuth 2.0, поэтому вы можете либо обрабатывать перенаправление напрямую, либо использовать обработчик SignInWithPopup() :

Подпись:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Расширяет: BaseOAuthProvider

Конструкторы

Конструктор	Модификаторы	Описание
(конструктор)()		Создает новый экземпляр класса GithubAuthProvider .

Характеристики

Свойство	Модификаторы	Тип	Описание
GITHUB_SIGN_IN_METHOD	static	'github.com'	Всегда установлено значение SignInMethod. .ГИХАБ.
PROVIDER_ID	static	'github.com'	Всегда установлено значение ProviderId. .ГИХАБ.

Методы

Метод	Модификаторы	Описание
учетные данные (токен доступа)	static	Создает учетные данные для GitHub.
credentialFromError (ошибка)	static	Используется для извлечения базового OAuthCredential из ошибки AuthError , возникшей во время операции входа, установления соединения или повторной аутентификации.
credentialFromResult (userCredential)	static	Используется для извлечения базового OAuthCredential из UserCredential. .

GithubAuthProvider.(конструктор)

Создает новый экземпляр класса GithubAuthProvider

Подпись:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Всегда установлено значение SignInMethod. .ГИХАБ.

Подпись:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Всегда установлено значение ProviderId. .ГИХАБ.

Подпись:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Создает учетные данные для GitHub.

Подпись:

static credential(accessToken: string): OAuthCredential;

Параметры

Параметр	Тип	Описание
токен доступа	нить	Токен доступа GitHub.

Возврат:

OAuthCredential

GithubAuthProvider.credentialFromError()

Используется для извлечения базового OAuthCredential из ошибки AuthError , возникшей во время операции входа, установления соединения или повторной аутентификации.

Подпись:

static credentialFromError(error: FirebaseError): OAuthCredential | null;

Параметры

Параметр	Тип	Описание
ошибка	FirebaseError

Возврат:

OAuthCredential | нулевой

GithubAuthProvider.credentialFromResult()

Используется для извлечения базового OAuthCredential из UserCredential. .

Подпись:

static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;

Параметры

Параметр	Тип	Описание
userCredential	Учетные данные пользователя	Учетные данные пользователя.

Возврат:

OAuthCredential | нулевой

Пример 1

// Sign in using a redirect.
const provider = new GithubAuthProvider();
// Start a sign in process for an unauthenticated user.
provider.addScope('repo');
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a GitHub Access Token.
  const credential = GithubAuthProvider.credentialFromResult(result);
  const token = credential.accessToken;
}

Пример 2

// Sign in using a popup.
const provider = new GithubAuthProvider();
provider.addScope('repo');
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;