Поставщик для создания общего OAuthCredential. .
Подпись:
export declare class OAuthProvider extends BaseOAuthProvider
Расширяет: BaseOAuthProvider
Методы
Метод | Модификаторы | Описание |
---|---|---|
учетные данные (параметры) | Создает OAuthCredential на основе токена доступа или идентификатора универсального поставщика OAuth. | |
credentialFromError (ошибка) | static | Используется для извлечения базового OAuthCredential из ошибки AuthError , возникшей во время операции входа, установления соединения или повторной аутентификации. |
учетные данныеFromJSON (json) | static | Создает OAuthCredential из строки JSON или простого объекта. |
credentialFromResult (userCredential) | static | Используется для извлечения базового OAuthCredential из UserCredential. . |
OAuthProvider.credential()
Создает OAuthCredential на основе токена доступа или идентификатора универсального поставщика OAuth.
Необработанный одноразовый номер требуется, когда предоставляется идентификационный токен с полем одноразового номера. Хэш SHA-256 необработанного одноразового номера должен совпадать с полем одноразового номера в идентификационном токене.
Подпись:
credential(params: OAuthCredentialOptions): OAuthCredential;
Параметры
Параметр | Тип | Описание |
---|---|---|
параметры | Оаускредентиоптионс | Либо объект параметров, содержащий токен идентификатора, токен доступа и необработанный одноразовый номер, либо строку токена идентификатора. |
Возврат:
Пример
// `googleUser` from the onsuccess Google Sign In callback.
// Initialize a generate OAuth provider with a `google.com` providerId.
const provider = new OAuthProvider('google.com');
const credential = provider.credential({
idToken: googleUser.getAuthResponse().id_token,
});
const result = await signInWithCredential(credential);
OAuthProvider.credentialFromError()
Используется для извлечения базового OAuthCredential из ошибки AuthError , возникшей во время операции входа, установления соединения или повторной аутентификации.
Подпись:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
Параметры
Параметр | Тип | Описание |
---|---|---|
ошибка | FirebaseError |
Возврат:
OAuthCredential | нулевой
OAuthProvider.credentialFromJSON()
Создает OAuthCredential из строки JSON или простого объекта.
Подпись:
static credentialFromJSON(json: object | string): OAuthCredential;
Параметры
Параметр | Тип | Описание |
---|---|---|
JSON | объект | нить | Простой объект или строка JSON. |
Возврат:
OAuthProvider.credentialFromResult()
Используется для извлечения базового OAuthCredential из UserCredential. .
Подпись:
static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
Параметры
Параметр | Тип | Описание |
---|---|---|
userCredential | Учетные данные пользователя | Учетные данные пользователя. |
Возврат:
OAuthCredential | нулевой
Пример 1
// Sign in using a redirect.
const provider = new OAuthProvider('google.com');
// Start a sign in process for an unauthenticated user.
provider.addScope('profile');
provider.addScope('email');
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 OAuth Access Token for the provider.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;
}
Пример 2
// Sign in using a popup.
const provider = new OAuthProvider('google.com');
provider.addScope('profile');
provider.addScope('email');
const result = await signInWithPopup(auth, provider);
// The signed-in user info.
const user = result.user;
// This gives you a OAuth Access Token for the provider.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;