Callable
Index
Modules
Classes
- Action
CodeURL - Auth
Credential - Email
Auth Provider - Facebook
Auth Provider - Github
Auth Provider - Google
Auth Provider - Multi
Factor Assertion - Multi
Factor Resolver - Multi
Factor Session - OAuth
Credential - OAuth
Provider - Phone
Auth Credential - Phone
Auth Provider - Phone
Multi Factor Assertion - Phone
Multi Factor Generator - SAMLAuth
Provider - Twitter
Auth Provider
Interfaces
- Application
Verifier - Auth
Error - Auth
Provider - Auth
Settings - Config
- Confirmation
Result - Emulator
Config - Error
- Id
Token Result - Multi
Factor Error - Multi
Factor Info - OAuth
Credential Options - Phone
Multi Factor Enroll Info Options - Phone
Multi Factor Info - Phone
Multi Factor Sign InInfo Options - Phone
Single Factor Info Options - User
Metadata
Type aliases
Type aliases
ActionCodeSettings
This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. The action code setting fields are:
url: Sets the link continue/state URL, which has different meanings in different contexts:
- When the link is handled in the web action widgets, this is the deep link in the continueUrl query parameter.
- When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link.
- iOS: Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed.
- android: Sets the Android package name. This will try to open the link in an android app if it is installed. If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field. If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app.
- handleCodeInApp: The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed.
Type declaration
-
Optional android?: { installApp?: boolean; minimumVersion?: string; packageName: string }
-
Optional install
App?: boolean -
Optional minimum
Version?: string -
package
Name: string
-
-
Optional dynamic
Link Domain?: string -
Optional handle
Code InApp?: boolean -
Optional iOS?: { bundleId: string }
-
bundle
Id: string
-
-
url: string
AdditionalUserInfo
A structure containing additional user information from a federated identity provider.
Type declaration
-
is
New User: boolean -
profile: Object | null
-
provider
Id: string -
Optional username?: string | null
PhoneInfoOptions
The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in.
UserCredential
A structure containing a User, an AuthCredential, the operationType, and any additional user information that was returned from the identity provider. operationType could be 'signIn' for a sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation.
Type declaration
-
Optional additional
User Info?: AdditionalUserInfo | null -
credential: AuthCredential | null
-
Optional operation
Type?: string | null -
user: User | null
Gets the
Auth
service for the default app or a given app.firebase.auth()
can be called with no arguments to access the default app'sAuth
service or asfirebase.auth(app)
to access theAuth
service associated with a specific app.// Get the Auth service for the default app var defaultAuth = firebase.auth();
// Get the Auth service for a given app var otherAuth = firebase.auth(otherApp);