Auth | JavaScript SDK  |  Firebase JavaScript API reference (original) (raw)

Index

Type aliases

Persistence

Persistence: string

Properties

app

config

currentUser

currentUser: User | null

emulatorConfig

languageCode

languageCode: string | null

name

name: string

settings

tenantId

tenantId: string | null

Variables

Persistence

Methods

applyActionCode

• applyActionCode( code : string ) : Promise < void >

• Parameters

  • code: string

Returns Promise<void>

checkActionCode

• checkActionCode( code : string ) : Promise < ActionCodeInfo >

• Parameters

  • code: string

Returns Promise<ActionCodeInfo>

confirmPasswordReset

• confirmPasswordReset( code : string , newPassword : string ) : Promise < void >

• Parameters

  • code: string

  • newPassword: string

Returns Promise<void>

createUserWithEmailAndPassword

• createUserWithEmailAndPassword( email : string , password : string ) : Promise < UserCredential >

• Parameters

  • email: string

  • password: string

Returns Promise<UserCredential>

fetchSignInMethodsForEmail

• fetchSignInMethodsForEmail( email : string ) : Promise < Array < string > >

• Parameters

  • email: string

Returns Promise<Array<string>>

getRedirectResult

• getRedirectResult( ) : Promise < UserCredential >

• Returns Promise<UserCredential>

isSignInWithEmailLink

• isSignInWithEmailLink( emailLink : string ) : boolean

• Parameters

  • emailLink: string

Returns boolean

onAuthStateChanged

• onAuthStateChanged( nextOrObserver : Observer < any > | ( ( a : User | null ) => any ) , error ? : ( a : Error ) => any , completed ? : firebase.Unsubscribe ) : firebase.Unsubscribe

• Parameters

  • nextOrObserver: Observer<any> | ((a: User | null) => any)

  • Optional error: (a: Error) => any

    * * (a: [Error](/docs/reference/js/v8/firebase.auth.Error)): any  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.auth.Error)  
             #### Returns any  

  • Optional completed: firebase.Unsubscribe

Returns firebase.Unsubscribe

onIdTokenChanged

• onIdTokenChanged( nextOrObserver : Observer < any > | ( ( a : User | null ) => any ) , error ? : ( a : Error ) => any , completed ? : firebase.Unsubscribe ) : firebase.Unsubscribe

• Parameters

  • nextOrObserver: Observer<any> | ((a: User | null) => any)

  • Optional error: (a: Error) => any

    * * (a: [Error](/docs/reference/js/v8/firebase.auth.Error)): any  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.auth.Error)  
             #### Returns any  

  • Optional completed: firebase.Unsubscribe

Returns firebase.Unsubscribe

sendPasswordResetEmail

• sendPasswordResetEmail( email : string , actionCodeSettings ? : ActionCodeSettings | null ) : Promise < void >

• Parameters

  • email: string

  • Optional actionCodeSettings: ActionCodeSettings | null

Returns Promise<void>

sendSignInLinkToEmail

• sendSignInLinkToEmail( email : string , actionCodeSettings : ActionCodeSettings ) : Promise < void >

• Parameters

  • email: string

  • actionCodeSettings: ActionCodeSettings

Returns Promise<void>

setPersistence

• setPersistence( persistence : Persistence ) : Promise < void >

• Parameters

  • persistence: Persistence

Returns Promise<void>

signInAndRetrieveDataWithCredential

• signInAndRetrieveDataWithCredential( credential : AuthCredential ) : Promise < UserCredential >

• Parameters

  • credential: AuthCredential

Returns Promise<UserCredential>

signInAnonymously

• signInAnonymously( ) : Promise < UserCredential >

• Returns Promise<UserCredential>

signInWithCredential

• signInWithCredential( credential : AuthCredential ) : Promise < UserCredential >

• Parameters

  • credential: AuthCredential

Returns Promise<UserCredential>

signInWithCustomToken

• signInWithCustomToken( token : string ) : Promise < UserCredential >

• Parameters

  • token: string

Returns Promise<UserCredential>

signInWithEmailAndPassword

• signInWithEmailAndPassword( email : string , password : string ) : Promise < UserCredential >

• Parameters

  • email: string

  • password: string

Returns Promise<UserCredential>

signInWithEmailLink

• signInWithEmailLink( email : string , emailLink ? : string ) : Promise < UserCredential >

• Parameters

  • email: string

  • Optional emailLink: string

Returns Promise<UserCredential>

signInWithPhoneNumber

• signInWithPhoneNumber( phoneNumber : string , applicationVerifier : ApplicationVerifier ) : Promise < ConfirmationResult >

• Parameters

  • phoneNumber: string

  • applicationVerifier: ApplicationVerifier

Returns Promise<ConfirmationResult>

• signInWithPopup( provider : AuthProvider ) : Promise < UserCredential >

• Parameters

  • provider: AuthProvider

Returns Promise<UserCredential>

signInWithRedirect

• signInWithRedirect( provider : AuthProvider ) : Promise < void >

• Parameters

  • provider: AuthProvider

Returns Promise<void>

signOut

• signOut( ) : Promise < void >

• Returns Promise<void>

updateCurrentUser

• updateCurrentUser( user : User | null ) : Promise < void >

• Parameters

  • user: User | null

Returns Promise<void>

useDeviceLanguage

• useDeviceLanguage( ) : void

• Returns void

useEmulator

• useEmulator( url : string ) : void

• Parameters

  • url: string

Returns void

verifyPasswordResetCode

• verifyPasswordResetCode( code : string ) : Promise < string >

• Parameters

  • code: string

Returns Promise<string>