Skip to content

Latest commit

 

History

History
919 lines (782 loc) · 32.6 KB

auth.api.md

File metadata and controls

919 lines (782 loc) · 32.6 KB

API Report File for "@firebase/auth"

Do not edit this file. It is a report generated by API Extractor.

import{CompleteFn}from'@firebase/util';import{ErrorFactory}from'@firebase/util';import{ErrorFn}from'@firebase/util';import{FirebaseApp}from'@firebase/app';import{FirebaseError}from'@firebase/util';import{NextFn}from'@firebase/util';import{Observer}from'@firebase/util';import{Unsubscribe}from'@firebase/util';// @publicexportinterfaceActionCodeInfo{data: {email?: string|null;multiFactorInfo?: MultiFactorInfo|null;previousEmail?: string|null;};operation: (typeofActionCodeOperation)[keyoftypeofActionCodeOperation];}// @publicexportconstActionCodeOperation: {readonlyEMAIL_SIGNIN: "EMAIL_SIGNIN";readonlyPASSWORD_RESET: "PASSWORD_RESET";readonlyRECOVER_EMAIL: "RECOVER_EMAIL";readonlyREVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";readonlyVERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";readonlyVERIFY_EMAIL: "VERIFY_EMAIL";};// @publicexportinterfaceActionCodeSettings{android?: {installApp?: boolean;minimumVersion?: string;packageName: string;};// @deprecateddynamicLinkDomain?: string;handleCodeInApp?: boolean;iOS?: {bundleId: string;};linkDomain?: string;url: string;}// @publicexportclassActionCodeURL{// @internalconstructor(actionLink: string);readonlyapiKey: string;readonlycode: string;readonlycontinueUrl: string|null;readonlylanguageCode: string|null;readonlyoperation: string;staticparseLink(link: string): ActionCodeURL|null;readonlytenantId: string|null;}// @publicexportinterfaceAdditionalUserInfo{readonlyisNewUser: boolean;readonlyprofile: Record<string,unknown>|null;readonlyproviderId: string|null;readonlyusername?: string|null;}// @publicexportinterfaceApplicationVerifier{readonlytype: string;verify(): Promise<string>;}// @publicexportfunctionapplyActionCode(auth: Auth,oobCode: string): Promise<void>;// @publicexportinterfaceAuth{readonlyapp: FirebaseApp;authStateReady(): Promise<void>;beforeAuthStateChanged(callback: (user: User|null)=>void|Promise<void>,onAbort?: ()=>void): Unsubscribe;readonlyconfig: Config;readonlycurrentUser: User|null;readonlyemulatorConfig: EmulatorConfig|null;languageCode: string|null;readonlyname: string;onAuthStateChanged(nextOrObserver: NextOrObserver<User|null>,error?: ErrorFn,completed?: CompleteFn): Unsubscribe;onIdTokenChanged(nextOrObserver: NextOrObserver<User|null>,error?: ErrorFn,completed?: CompleteFn): Unsubscribe;setPersistence(persistence: Persistence): Promise<void>;readonlysettings: AuthSettings;signOut(): Promise<void>;tenantId: string|null;updateCurrentUser(user: User|null): Promise<void>;useDeviceLanguage(): void;}// @publicexportclassAuthCredential{// @internalprotectedconstructor(providerId: string,signInMethod: string);// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts//// @internal (undocumented)_getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;// @internal (undocumented)_getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts//// @internal (undocumented)_linkToIdToken(_auth: AuthInternal,_idToken: string): Promise<IdTokenResponse>;readonlyproviderId: string;readonlysignInMethod: string;toJSON(): object;}// @publicexportinterfaceAuthErrorextendsFirebaseError{readonlycustomData: {readonlyappName: string;readonlyemail?: string;readonlyphoneNumber?: string;readonlytenantId?: string;};}// @publicexportconstAuthErrorCodes: {readonlyADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";readonlyARGUMENT_ERROR: "auth/argument-error";readonlyAPP_NOT_AUTHORIZED: "auth/app-not-authorized";readonlyAPP_NOT_INSTALLED: "auth/app-not-installed";readonlyCAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";readonlyCODE_EXPIRED: "auth/code-expired";readonlyCORDOVA_NOT_READY: "auth/cordova-not-ready";readonlyCORS_UNSUPPORTED: "auth/cors-unsupported";readonlyCREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";readonlyCREDENTIAL_MISMATCH: "auth/custom-token-mismatch";readonlyCREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";readonlyDEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";readonlyDYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";readonlyEMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";readonlyEMAIL_EXISTS: "auth/email-already-in-use";readonlyEMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";readonlyEXPIRED_OOB_CODE: "auth/expired-action-code";readonlyEXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";readonlyINTERNAL_ERROR: "auth/internal-error";readonlyINVALID_API_KEY: "auth/invalid-api-key";readonlyINVALID_APP_CREDENTIAL: "auth/invalid-app-credential";readonlyINVALID_APP_ID: "auth/invalid-app-id";readonlyINVALID_AUTH: "auth/invalid-user-token";readonlyINVALID_AUTH_EVENT: "auth/invalid-auth-event";readonlyINVALID_CERT_HASH: "auth/invalid-cert-hash";readonlyINVALID_CODE: "auth/invalid-verification-code";readonlyINVALID_CONTINUE_URI: "auth/invalid-continue-uri";readonlyINVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";readonlyINVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";readonlyINVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";readonlyINVALID_EMAIL: "auth/invalid-email";readonlyINVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";readonlyINVALID_IDP_RESPONSE: "auth/invalid-credential";readonlyINVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";readonlyINVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";readonlyINVALID_MFA_SESSION: "auth/invalid-multi-factor-session";readonlyINVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";readonlyINVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";readonlyINVALID_OOB_CODE: "auth/invalid-action-code";readonlyINVALID_ORIGIN: "auth/unauthorized-domain";readonlyINVALID_PASSWORD: "auth/wrong-password";readonlyINVALID_PERSISTENCE: "auth/invalid-persistence-type";readonlyINVALID_PHONE_NUMBER: "auth/invalid-phone-number";readonlyINVALID_PROVIDER_ID: "auth/invalid-provider-id";readonlyINVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";readonlyINVALID_SENDER: "auth/invalid-sender";readonlyINVALID_SESSION_INFO: "auth/invalid-verification-id";readonlyINVALID_TENANT_ID: "auth/invalid-tenant-id";readonlyMFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";readonlyMFA_REQUIRED: "auth/multi-factor-auth-required";readonlyMISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";readonlyMISSING_APP_CREDENTIAL: "auth/missing-app-credential";readonlyMISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";readonlyMISSING_CODE: "auth/missing-verification-code";readonlyMISSING_CONTINUE_URI: "auth/missing-continue-uri";readonlyMISSING_IFRAME_START: "auth/missing-iframe-start";readonlyMISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";readonlyMISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";readonlyMISSING_MFA_INFO: "auth/missing-multi-factor-info";readonlyMISSING_MFA_SESSION: "auth/missing-multi-factor-session";readonlyMISSING_PHONE_NUMBER: "auth/missing-phone-number";readonlyMISSING_SESSION_INFO: "auth/missing-verification-id";readonlyMODULE_DESTROYED: "auth/app-deleted";readonlyNEED_CONFIRMATION: "auth/account-exists-with-different-credential";readonlyNETWORK_REQUEST_FAILED: "auth/network-request-failed";readonlyNULL_USER: "auth/null-user";readonlyNO_AUTH_EVENT: "auth/no-auth-event";readonlyNO_SUCH_PROVIDER: "auth/no-such-provider";readonlyOPERATION_NOT_ALLOWED: "auth/operation-not-allowed";readonlyOPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";readonlyPOPUP_BLOCKED: "auth/popup-blocked";readonlyPOPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";readonlyPROVIDER_ALREADY_LINKED: "auth/provider-already-linked";readonlyQUOTA_EXCEEDED: "auth/quota-exceeded";readonlyREDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";readonlyREDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";readonlyREJECTED_CREDENTIAL: "auth/rejected-credential";readonlySECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";readonlySECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";readonlyTENANT_ID_MISMATCH: "auth/tenant-id-mismatch";readonlyTIMEOUT: "auth/timeout";readonlyTOKEN_EXPIRED: "auth/user-token-expired";readonlyTOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";readonlyUNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";readonlyUNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";readonlyUNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";readonlyUNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";readonlyUNVERIFIED_EMAIL: "auth/unverified-email";readonlyUSER_CANCELLED: "auth/user-cancelled";readonlyUSER_DELETED: "auth/user-not-found";readonlyUSER_DISABLED: "auth/user-disabled";readonlyUSER_MISMATCH: "auth/user-mismatch";readonlyUSER_SIGNED_OUT: "auth/user-signed-out";readonlyWEAK_PASSWORD: "auth/weak-password";readonlyWEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";readonlyALREADY_INITIALIZED: "auth/already-initialized";readonlyRECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";readonlyMISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";readonlyINVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";readonlyINVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";readonlyMISSING_CLIENT_TYPE: "auth/missing-client-type";readonlyMISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";readonlyINVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";readonlyINVALID_REQ_TYPE: "auth/invalid-req-type";readonlyINVALID_HOSTING_LINK_DOMAIN: "auth/invalid-hosting-link-domain";};// @publicexportinterfaceAuthErrorMap{}// @publicexportinterfaceAuthProvider{readonlyproviderId: string;}// @publicexportinterfaceAuthSettings{appVerificationDisabledForTesting: boolean;}// @publicexportfunctionbeforeAuthStateChanged(auth: Auth,callback: (user: User|null)=>void|Promise<void>,onAbort?: ()=>void): Unsubscribe;// @betaexportconstbrowserCookiePersistence: Persistence;// @publicexportconstbrowserLocalPersistence: Persistence;// @publicexportconstbrowserPopupRedirectResolver: PopupRedirectResolver;// @publicexportconstbrowserSessionPersistence: Persistence;// @publicexportfunctioncheckActionCode(auth: Auth,oobCode: string): Promise<ActionCodeInfo>;export{CompleteFn}// @publicexportinterfaceConfig{apiHost: string;apiKey: string;apiScheme: string;authDomain?: string;sdkClientVersion: string;tokenApiHost: string;}// @publicexportinterfaceConfirmationResult{confirm(verificationCode: string): Promise<UserCredential>;readonlyverificationId: string;}// @publicexportfunctionconfirmPasswordReset(auth: Auth,oobCode: string,newPassword: string): Promise<void>;// @publicexportfunctionconnectAuthEmulator(auth: Auth,url: string,options?: {disableWarnings: boolean;}): void;// @publicexportfunctioncreateUserWithEmailAndPassword(auth: Auth,email: string,password: string): Promise<UserCredential>;// @publicexporttypeCustomParameters=Record<string,string>;// @publicexportconstdebugErrorMap: AuthErrorMap;// @publicexportfunctiondeleteUser(user: User): Promise<void>;// @publicexportinterfaceDependencies{errorMap?: AuthErrorMap;persistence?: Persistence|Persistence[];popupRedirectResolver?: PopupRedirectResolver;}// @publicexportclassEmailAuthCredentialextendsAuthCredential{// @internal (undocumented)readonly_email: string;// @internal (undocumented)static_fromEmailAndCode(email: string,oobCode: string,tenantId?: string|null): EmailAuthCredential;// @internal (undocumented)static_fromEmailAndPassword(email: string,password: string): EmailAuthCredential;staticfromJSON(json: object|string): EmailAuthCredential|null;// @internal (undocumented)_getIdTokenResponse(auth: AuthInternal): Promise<IdTokenResponse>;// @internal (undocumented)_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;// @internal (undocumented)_linkToIdToken(auth: AuthInternal,idToken: string): Promise<IdTokenResponse>;// @internal (undocumented)readonly_password: string;// @internal (undocumented)readonly_tenantId: string|null;toJSON(): object;}// @publicexportclassEmailAuthProviderimplementsAuthProvider{staticcredential(email: string,password: string): EmailAuthCredential;staticcredentialWithLink(email: string,emailLink: string): EmailAuthCredential;staticreadonlyEMAIL_LINK_SIGN_IN_METHOD: 'emailLink';staticreadonlyEMAIL_PASSWORD_SIGN_IN_METHOD: 'password';staticreadonlyPROVIDER_ID: 'password';readonlyproviderId: "password";}// @publicexportinterfaceEmulatorConfig{readonlyhost: string;readonlyoptions: {readonlydisableWarnings: boolean;};readonlyport: number|null;readonlyprotocol: string;}export{ErrorFn}// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts//// @publicexportclassFacebookAuthProviderextendsBaseOAuthProvider{constructor();staticcredential(accessToken: string): OAuthCredential;staticcredentialFromError(error: FirebaseError): OAuthCredential|null;staticcredentialFromResult(userCredential: UserCredential): OAuthCredential|null;staticreadonlyFACEBOOK_SIGN_IN_METHOD: 'facebook.com';staticreadonlyPROVIDER_ID: 'facebook.com';}// @publicexportconstFactorId: {readonlyPHONE: "phone";readonlyTOTP: "totp";};// @publicexportfunctionfetchSignInMethodsForEmail(auth: Auth,email: string): Promise<string[]>;// @publicexportfunctiongetAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo|null;// @publicexportfunctiongetAuth(app?: FirebaseApp): Auth;// @publicexportfunctiongetIdToken(user: User,forceRefresh?: boolean): Promise<string>;// @publicexportfunctiongetIdTokenResult(user: User,forceRefresh?: boolean): Promise<IdTokenResult>;// @publicexportfunctiongetMultiFactorResolver(auth: Auth,error: MultiFactorError): MultiFactorResolver;// @publicexportfunctiongetRedirectResult(auth: Auth,resolver?: PopupRedirectResolver): Promise<UserCredential|null>;// @publicexportclassGithubAuthProviderextendsBaseOAuthProvider{constructor();staticcredential(accessToken: string): OAuthCredential;staticcredentialFromError(error: FirebaseError): OAuthCredential|null;staticcredentialFromResult(userCredential: UserCredential): OAuthCredential|null;staticreadonlyGITHUB_SIGN_IN_METHOD: 'github.com';staticreadonlyPROVIDER_ID: 'github.com';}// @publicexportclassGoogleAuthProviderextendsBaseOAuthProvider{constructor();staticcredential(idToken?: string|null,accessToken?: string|null): OAuthCredential;staticcredentialFromError(error: FirebaseError): OAuthCredential|null;staticcredentialFromResult(userCredential: UserCredential): OAuthCredential|null;staticreadonlyGOOGLE_SIGN_IN_METHOD: 'google.com';staticreadonlyPROVIDER_ID: 'google.com';}// @publicexportinterfaceIdTokenResult{authTime: string;claims: ParsedToken;expirationTime: string;issuedAtTime: string;signInProvider: string|null;signInSecondFactor: string|null;token: string;}// @publicexportconstindexedDBLocalPersistence: Persistence;// @publicexportfunctioninitializeAuth(app: FirebaseApp,deps?: Dependencies): Auth;// @publicexportfunctioninitializeRecaptchaConfig(auth: Auth): Promise<void>;// @publicexportconstinMemoryPersistence: Persistence;// @publicexportfunctionisSignInWithEmailLink(auth: Auth,emailLink: string): boolean;// @publicexportfunctionlinkWithCredential(user: User,credential: AuthCredential): Promise<UserCredential>;// @publicexportfunctionlinkWithPhoneNumber(user: User,phoneNumber: string,appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;// @publicexportfunctionlinkWithPopup(user: User,provider: AuthProvider,resolver?: PopupRedirectResolver): Promise<UserCredential>;// @publicexportfunctionlinkWithRedirect(user: User,provider: AuthProvider,resolver?: PopupRedirectResolver): Promise<never>;// @publicexportfunctionmultiFactor(user: User): MultiFactorUser;// @publicexportinterfaceMultiFactorAssertion{readonlyfactorId: (typeofFactorId)[keyoftypeofFactorId];}// @publicexportinterfaceMultiFactorErrorextendsAuthError{readonlycustomData: AuthError['customData']&{readonlyoperationType: (typeofOperationType)[keyoftypeofOperationType];};}// @publicexportinterfaceMultiFactorInfo{readonlydisplayName?: string|null;readonlyenrollmentTime: string;readonlyfactorId: (typeofFactorId)[keyoftypeofFactorId];readonlyuid: string;}// @publicexportinterfaceMultiFactorResolver{readonlyhints: MultiFactorInfo[];resolveSignIn(assertion: MultiFactorAssertion): Promise<UserCredential>;readonlysession: MultiFactorSession;}// @publicexportinterfaceMultiFactorSession{}// @publicexportinterfaceMultiFactorUser{enroll(assertion: MultiFactorAssertion,displayName?: string|null): Promise<void>;readonlyenrolledFactors: MultiFactorInfo[];getSession(): Promise<MultiFactorSession>;unenroll(option: MultiFactorInfo|string): Promise<void>;}export{NextFn}// @publicexporttypeNextOrObserver<T>=NextFn<T|null>|Observer<T|null>;// @publicexportclassOAuthCredentialextendsAuthCredential{accessToken?: string;staticfromJSON(json: string|object): OAuthCredential|null;// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts//// @internal (undocumented)static_fromParams(params: OAuthCredentialParams): OAuthCredential;// @internal (undocumented)_getIdTokenResponse(auth: AuthInternal): Promise<IdTokenResponse>;// @internal (undocumented)_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;idToken?: string;// @internal (undocumented)_linkToIdToken(auth: AuthInternal,idToken: string): Promise<IdTokenResponse>;secret?: string;toJSON(): object;}// @publicexportinterfaceOAuthCredentialOptions{accessToken?: string;idToken?: string;rawNonce?: string;}// @publicexportclassOAuthProviderextendsBaseOAuthProvider{credential(params: OAuthCredentialOptions): OAuthCredential;staticcredentialFromError(error: FirebaseError): OAuthCredential|null;staticcredentialFromJSON(json: object|string): OAuthCredential;staticcredentialFromResult(userCredential: UserCredential): OAuthCredential|null;}// @publicexportfunctiononAuthStateChanged(auth: Auth,nextOrObserver: NextOrObserver<User>,error?: ErrorFn,completed?: CompleteFn): Unsubscribe;// @publicexportfunctiononIdTokenChanged(auth: Auth,nextOrObserver: NextOrObserver<User>,error?: ErrorFn,completed?: CompleteFn): Unsubscribe;// @publicexportconstOperationType: {readonlyLINK: "link";readonlyREAUTHENTICATE: "reauthenticate";readonlySIGN_IN: "signIn";};// @publicexportfunctionparseActionCodeURL(link: string): ActionCodeURL|null;// @publicexportinterfaceParsedToken{[key: string]: unknown;'auth_time'?: string;'exp'?: string;'firebase'?: {'sign_in_provider'?: string;'sign_in_second_factor'?: string;'identities'?: Record<string,string>;};'iat'?: string;'sub'?: string;}// @publicexportinterfacePasswordPolicy{readonlyallowedNonAlphanumericCharacters: string;readonlycustomStrengthOptions: {readonlyminPasswordLength?: number;readonlymaxPasswordLength?: number;readonlycontainsLowercaseLetter?: boolean;readonlycontainsUppercaseLetter?: boolean;readonlycontainsNumericCharacter?: boolean;readonlycontainsNonAlphanumericCharacter?: boolean;};readonlyenforcementState: string;readonlyforceUpgradeOnSignin: boolean;}// @publicexportinterfacePasswordValidationStatus{readonlycontainsLowercaseLetter?: boolean;readonlycontainsNonAlphanumericCharacter?: boolean;readonlycontainsNumericCharacter?: boolean;readonlycontainsUppercaseLetter?: boolean;readonlyisValid: boolean;readonlymeetsMaxPasswordLength?: boolean;readonlymeetsMinPasswordLength?: boolean;readonlypasswordPolicy: PasswordPolicy;}// @publicexportinterfacePersistence{readonlytype: 'SESSION'|'LOCAL'|'NONE'|'COOKIE';}// @publicexportclassPhoneAuthCredentialextendsAuthCredential{staticfromJSON(json: object|string): PhoneAuthCredential|null;// @internal (undocumented)static_fromTokenResponse(phoneNumber: string,temporaryProof: string): PhoneAuthCredential;// @internal (undocumented)static_fromVerification(verificationId: string,verificationCode: string): PhoneAuthCredential;// @internal (undocumented)_getIdTokenResponse(auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;// @internal (undocumented)_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;// @internal (undocumented)_linkToIdToken(auth: AuthInternal,idToken: string): Promise<IdTokenResponse>;// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts//// @internal (undocumented)_makeVerificationRequest(): SignInWithPhoneNumberRequest;toJSON(): object;}// @publicexportclassPhoneAuthProvider{constructor(auth: Auth);staticcredential(verificationId: string,verificationCode: string): PhoneAuthCredential;staticcredentialFromError(error: FirebaseError): AuthCredential|null;staticcredentialFromResult(userCredential: UserCredential): AuthCredential|null;staticreadonlyPHONE_SIGN_IN_METHOD: 'phone';staticreadonlyPROVIDER_ID: 'phone';readonlyproviderId: "phone";verifyPhoneNumber(phoneOptions: PhoneInfoOptions|string,applicationVerifier?: ApplicationVerifier): Promise<string>;}// @publicexporttypePhoneInfoOptions=PhoneSingleFactorInfoOptions|PhoneMultiFactorEnrollInfoOptions|PhoneMultiFactorSignInInfoOptions;// @publicexportinterfacePhoneMultiFactorAssertionextendsMultiFactorAssertion{}// @publicexportinterfacePhoneMultiFactorEnrollInfoOptions{phoneNumber: string;session: MultiFactorSession;}// @publicexportclassPhoneMultiFactorGenerator{staticassertion(credential: PhoneAuthCredential): PhoneMultiFactorAssertion;staticFACTOR_ID: string;}// @publicexportinterfacePhoneMultiFactorInfoextendsMultiFactorInfo{readonlyphoneNumber: string;}// @publicexportinterfacePhoneMultiFactorSignInInfoOptions{multiFactorHint?: MultiFactorInfo;multiFactorUid?: string;session: MultiFactorSession;}// @publicexportinterfacePhoneSingleFactorInfoOptions{phoneNumber: string;}// @publicexportinterfacePopupRedirectResolver{}// @publicexportconstprodErrorMap: AuthErrorMap;// @publicexportconstProviderId: {readonlyFACEBOOK: "facebook.com";readonlyGITHUB: "github.com";readonlyGOOGLE: "google.com";readonlyPASSWORD: "password";readonlyPHONE: "phone";readonlyTWITTER: "twitter.com";};// @publicexportinterfaceReactNativeAsyncStorage{getItem(key: string): Promise<string|null>;removeItem(key: string): Promise<void>;setItem(key: string,value: string): Promise<void>;}// @publicexportfunctionreauthenticateWithCredential(user: User,credential: AuthCredential): Promise<UserCredential>;// @publicexportfunctionreauthenticateWithPhoneNumber(user: User,phoneNumber: string,appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;// @publicexportfunctionreauthenticateWithPopup(user: User,provider: AuthProvider,resolver?: PopupRedirectResolver): Promise<UserCredential>;// @publicexportfunctionreauthenticateWithRedirect(user: User,provider: AuthProvider,resolver?: PopupRedirectResolver): Promise<never>;// @publicexportinterfaceRecaptchaParameters{// (undocumented)[key: string]: any;}// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts//// @publicexportclassRecaptchaVerifierimplementsApplicationVerifierInternal{constructor(authExtern: Auth,containerOrId: HTMLElement|string,parameters?: RecaptchaParameters);clear(): void;// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts//// @internal (undocumented)readonly_recaptchaLoader: ReCaptchaLoader;render(): Promise<number>;// @internal (undocumented)_reset(): void;readonlytype="recaptcha";verify(): Promise<string>;}// @publicexportfunctionreload(user: User): Promise<void>;// @publicexportfunctionrevokeAccessToken(auth: Auth,token: string): Promise<void>;// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts//// @publicexportclassSAMLAuthProviderextendsFederatedAuthProvider{constructor(providerId: string);staticcredentialFromError(error: FirebaseError): AuthCredential|null;staticcredentialFromJSON(json: string|object): AuthCredential;staticcredentialFromResult(userCredential: UserCredential): AuthCredential|null;}// @publicexportfunctionsendEmailVerification(user: User,actionCodeSettings?: ActionCodeSettings|null): Promise<void>;// @publicexportfunctionsendPasswordResetEmail(auth: Auth,email: string,actionCodeSettings?: ActionCodeSettings): Promise<void>;// @publicexportfunctionsendSignInLinkToEmail(auth: Auth,email: string,actionCodeSettings: ActionCodeSettings): Promise<void>;// @publicexportfunctionsetPersistence(auth: Auth,persistence: Persistence): Promise<void>;// @publicexportfunctionsignInAnonymously(auth: Auth): Promise<UserCredential>;// @publicexportconstSignInMethod: {readonlyEMAIL_LINK: "emailLink";readonlyEMAIL_PASSWORD: "password";readonlyFACEBOOK: "facebook.com";readonlyGITHUB: "github.com";readonlyGOOGLE: "google.com";readonlyPHONE: "phone";readonlyTWITTER: "twitter.com";};// @publicexportfunctionsignInWithCredential(auth: Auth,credential: AuthCredential): Promise<UserCredential>;// @publicexportfunctionsignInWithCustomToken(auth: Auth,customToken: string): Promise<UserCredential>;// @publicexportfunctionsignInWithEmailAndPassword(auth: Auth,email: string,password: string): Promise<UserCredential>;// @publicexportfunctionsignInWithEmailLink(auth: Auth,email: string,emailLink?: string): Promise<UserCredential>;// @publicexportfunctionsignInWithPhoneNumber(auth: Auth,phoneNumber: string,appVerifier?: ApplicationVerifier): Promise<ConfirmationResult>;// @publicexportfunctionsignInWithPopup(auth: Auth,provider: AuthProvider,resolver?: PopupRedirectResolver): Promise<UserCredential>;// @publicexportfunctionsignInWithRedirect(auth: Auth,provider: AuthProvider,resolver?: PopupRedirectResolver): Promise<never>;// @publicexportfunctionsignOut(auth: Auth): Promise<void>;// @publicexportinterfaceTotpMultiFactorAssertionextendsMultiFactorAssertion{}// @publicexportclassTotpMultiFactorGenerator{staticassertionForEnrollment(secret: TotpSecret,oneTimePassword: string): TotpMultiFactorAssertion;staticassertionForSignIn(enrollmentId: string,oneTimePassword: string): TotpMultiFactorAssertion;staticFACTOR_ID: 'totp';staticgenerateSecret(session: MultiFactorSession): Promise<TotpSecret>;}// @publicexportinterfaceTotpMultiFactorInfoextendsMultiFactorInfo{}// @publicexportclassTotpSecret{readonlycodeIntervalSeconds: number;readonlycodeLength: number;readonlyenrollmentCompletionDeadline: string;// Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.d.ts//// @internal (undocumented)static_fromStartTotpMfaEnrollmentResponse(response: StartTotpMfaEnrollmentResponse,auth: AuthInternal): TotpSecret;generateQrCodeUrl(accountName?: string,issuer?: string): string;readonlyhashingAlgorithm: string;// Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.d.ts//// @internal (undocumented)_makeTotpVerificationInfo(otp: string): TotpVerificationInfo;readonlysecretKey: string;}// @publicexportclassTwitterAuthProviderextendsBaseOAuthProvider{constructor();staticcredential(token: string,secret: string): OAuthCredential;staticcredentialFromError(error: FirebaseError): OAuthCredential|null;staticcredentialFromResult(userCredential: UserCredential): OAuthCredential|null;staticreadonlyPROVIDER_ID: 'twitter.com';staticreadonlyTWITTER_SIGN_IN_METHOD: 'twitter.com';}// @publicexportfunctionunlink(user: User,providerId: string): Promise<User>;export{Unsubscribe}// @publicexportfunctionupdateCurrentUser(auth: Auth,user: User|null): Promise<void>;// @publicexportfunctionupdateEmail(user: User,newEmail: string): Promise<void>;// @publicexportfunctionupdatePassword(user: User,newPassword: string): Promise<void>;// @publicexportfunctionupdatePhoneNumber(user: User,credential: PhoneAuthCredential): Promise<void>;// @publicexportfunctionupdateProfile(user: User,{ displayName,photoURL: photoUrl}: {displayName?: string|null;photoURL?: string|null;}): Promise<void>;// @publicexportfunctionuseDeviceLanguage(auth: Auth): void;// @publicexportinterfaceUserextendsUserInfo{delete(): Promise<void>;readonlyemailVerified: boolean;getIdToken(forceRefresh?: boolean): Promise<string>;getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;readonlyisAnonymous: boolean;readonlymetadata: UserMetadata;readonlyproviderData: UserInfo[];readonlyrefreshToken: string;reload(): Promise<void>;readonlytenantId: string|null;toJSON(): object;}// @publicexportinterfaceUserCredential{operationType: (typeofOperationType)[keyoftypeofOperationType];providerId: string|null;user: User;}// @publicexportinterfaceUserInfo{readonlydisplayName: string|null;readonlyemail: string|null;readonlyphoneNumber: string|null;readonlyphotoURL: string|null;readonlyproviderId: string;readonlyuid: string;}// @publicexportinterfaceUserMetadata{readonlycreationTime?: string;readonlylastSignInTime?: string;}// @publicexporttypeUserProfile=Record<string,unknown>;// @publicexportfunctionvalidatePassword(auth: Auth,password: string): Promise<PasswordValidationStatus>;// @publicexportfunctionverifyBeforeUpdateEmail(user: User,newEmail: string,actionCodeSettings?: ActionCodeSettings|null): Promise<void>;// @publicexportfunctionverifyPasswordResetCode(auth: Auth,code: string): Promise<string>;
close