![PyPI Now Supports iOS and Android Wheels for Mobile Python Development](https://cdn.sanity.io/images/cgdhsj6q/production/96416c872705517a6a65ad9646ce3e7caef623a0-1024x1024.webp?w=400&fit=max&auto=format)
Security News
PyPI Now Supports iOS and Android Wheels for Mobile Python Development
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
@capacitor-firebase/authentication
Advanced tools
Capacitor plugin for Firebase Authentication.
⚡️ Capacitor plugin for Firebase Authentication.
npm install @capacitor-firebase/authentication firebase
npx cap sync
Add Firebase to your project if you haven't already (Android / iOS / Web).
On iOS, verify that this function is included in your app's AppDelegate.swift
:
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
}
The further installation steps depend on the selected authentication method:
Attention: Please note that this plugin uses third-party SDKs to offer native sign-in. These SDKs can initialize on their own and collect various data. Here you can find more information.
These configuration values are available:
Prop | Type | Description | Default |
---|---|---|---|
skipNativeAuth | boolean | Configure whether the plugin should skip the native authentication. Only needed if you want to use the Firebase JavaScript SDK. Only available for Android and iOS. | false |
providers | string[] | Configure which providers you want to use so that only the providers you need are fully initialized. If you do not configure any providers, they will be all initialized. Please note that this does not prevent the automatic initialization of third-party SDKs. Only available for Android and iOS. | ["apple.com", "facebook.com", "github.com", "google.com", "microsoft.com", "playgames.google.com", "twitter.com", "yahoo.com", "phone"] |
In capacitor.config.json
:
{
"plugins": {
"FirebaseAuthentication": {
"skipNativeAuth": false,
"providers": ["apple.com", "google.com"]
}
}
}
In capacitor.config.ts
:
/// <reference types="@capacitor/firebase-authentication" />
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
plugins: {
FirebaseAuthentication: {
skipNativeAuth: false,
providers: ["apple.com", "google.com"],
},
},
};
export default config;
A working example can be found here: robingenz/capacitor-firebase-authentication-demo
import { FirebaseAuthentication } from '@capacitor-firebase/authentication';
const getCurrentUser = async () => {
const result = await FirebaseAuthentication.getCurrentUser();
return result.user;
};
const getIdToken = async () => {
const result = await FirebaseAuthentication.getIdToken();
return result.token;
};
const setLanguageCode = async () => {
await FirebaseAuthentication.setLanguageCode({ languageCode: 'en-US' });
};
const signInWithApple = async () => {
await FirebaseAuthentication.signInWithApple();
};
const signInWithFacebook = async () => {
await FirebaseAuthentication.signInWithFacebook();
};
const signInWithGithub = async () => {
await FirebaseAuthentication.signInWithGithub();
};
const signInWithGoogle = async () => {
await FirebaseAuthentication.signInWithGoogle();
};
const signInWithMicrosoft = async () => {
await FirebaseAuthentication.signInWithMicrosoft();
};
const signInWithPlayGames = async () => {
await FirebaseAuthentication.signInWithPlayGames();
};
const signInWithPhoneNumber = async () => {
const { verificationId } = await FirebaseAuthentication.signInWithPhoneNumber(
{
phoneNumber: '123456789',
},
);
const verificationCode = window.prompt(
'Please enter the verification code that was sent to your mobile device.',
);
await FirebaseAuthentication.signInWithPhoneNumber({
verificationId,
verificationCode,
});
};
const signInWithTwitter = async () => {
await FirebaseAuthentication.signInWithTwitter();
};
const signInWithYahoo = async () => {
await FirebaseAuthentication.signInWithYahoo();
};
const signOut = async () => {
await FirebaseAuthentication.signOut();
};
const useAppLanguage = async () => {
await FirebaseAuthentication.useAppLanguage();
};
getCurrentUser()
getIdToken(...)
setLanguageCode(...)
signInWithApple(...)
signInWithFacebook(...)
signInWithGithub(...)
signInWithGoogle(...)
signInWithMicrosoft(...)
signInWithPlayGames(...)
signInWithTwitter(...)
signInWithYahoo(...)
signInWithPhoneNumber(...)
signInWithCustomToken(...)
signOut()
useAppLanguage()
useEmulator(...)
addListener('authStateChange', ...)
removeAllListeners()
getCurrentUser() => Promise<GetCurrentUserResult>
Fetches the currently signed-in user.
Returns: Promise<GetCurrentUserResult>
getIdToken(options?: GetIdTokenOptions | undefined) => Promise<GetIdTokenResult>
Fetches the Firebase Auth ID Token for the currently signed-in user.
Param | Type |
---|---|
options | GetIdTokenOptions |
Returns: Promise<GetIdTokenResult>
setLanguageCode(options: SetLanguageCodeOptions) => Promise<void>
Sets the user-facing language code for auth operations.
Param | Type |
---|---|
options | SetLanguageCodeOptions |
signInWithApple(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Apple sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithFacebook(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Facebook sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithGithub(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the GitHub sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithGoogle(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Google sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithMicrosoft(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Microsoft sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithPlayGames(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Play Games sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithTwitter(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Twitter sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithYahoo(options?: SignInOptions | undefined) => Promise<SignInResult>
Starts the Yahoo sign-in flow.
Param | Type |
---|---|
options | SignInOptions |
Returns: Promise<SignInResult>
signInWithPhoneNumber(options: SignInWithPhoneNumberOptions) => Promise<SignInWithPhoneNumberResult>
Starts the sign-in flow using a phone number.
Either the phone number or the verification code and verification ID must be provided.
Only available for Android and iOS.
Param | Type |
---|---|
options | SignInWithPhoneNumberOptions |
Returns: Promise<SignInWithPhoneNumberResult>
signInWithCustomToken(options: SignInWithCustomTokenOptions) => Promise<SignInResult>
Starts the Custom Token sign-in flow.
This method cannot be used in combination with skipNativeAuth
on Android and iOS.
In this case you have to use the signInWithCustomToken
interface of the Firebase JS SDK directly.
Param | Type |
---|---|
options | SignInWithCustomTokenOptions |
Returns: Promise<SignInResult>
signOut() => Promise<void>
Starts the sign-out flow.
useAppLanguage() => Promise<void>
Sets the user-facing language code to be the default app language.
useEmulator(options: UseEmulatorOptions) => Promise<void>
Instrument your app to talk to the Authentication emulator.
Param | Type |
---|---|
options | UseEmulatorOptions |
addListener(eventName: 'authStateChange', listenerFunc: AuthStateChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Listen for the user's sign-in state changes.
Param | Type |
---|---|
eventName | 'authStateChange' |
listenerFunc | AuthStateChangeListener |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
removeAllListeners() => Promise<void>
Remove all listeners for this plugin.
Prop | Type | Description |
---|---|---|
user | User | null | The currently signed-in user, or null if there isn't any. |
Prop | Type |
---|---|
displayName | string | null |
email | string | null |
emailVerified | boolean |
isAnonymous | boolean |
phoneNumber | string | null |
photoUrl | string | null |
providerId | string |
tenantId | string | null |
uid | string |
Prop | Type | Description |
---|---|---|
token | string | The Firebase Auth ID token JWT string. |
Prop | Type | Description |
---|---|---|
forceRefresh | boolean | Force refresh regardless of token expiration. |
Prop | Type | Description |
---|---|---|
languageCode | string | BCP 47 language code. Example: en-US . |
Prop | Type | Description |
---|---|---|
user | User | null | The currently signed-in user, or null if there isn't any. |
credential | AuthCredential | null | Credentials returned by an auth provider. |
Prop | Type | Description |
---|---|---|
providerId | string | The authentication provider ID for the credential. Example: google.com . |
accessToken | string | The OAuth access token associated with the credential if it belongs to an OAuth provider. |
idToken | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider. |
secret | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider. |
nonce | string | The random string used to make sure that the ID token you get was granted specifically in response to your app's authentication request. |
Prop | Type | Description |
---|---|---|
customParameters | SignInCustomParameter[] | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. |
Prop | Type | Description |
---|---|---|
key | string | The custom parameter key (e.g. login_hint ). |
value | string | The custom parameter value (e.g. user@firstadd.onmicrosoft.com ). |
Prop | Type | Description |
---|---|---|
verificationId | string | The verification ID, which is needed to identify the verification code. |
Prop | Type | Description |
---|---|---|
phoneNumber | string | The phone number to be verified. |
verificationId | string | The verification ID which will be returned when signInWithPhoneNumber is called for the first time. The verificationCode must also be provided. |
verificationCode | string | The verification code from the SMS message. The verificationId must also be provided. |
Prop | Type | Description |
---|---|---|
token | string | The custom token to sign in with. |
Prop | Type | Description |
---|---|---|
host | string | The emulator host (e.g. 10.0.2.2 ). |
port | number | The emulator host (e.g. 9099 ). Default: 9099 |
Prop | Type |
---|---|
remove | () => Promise<void> |
Prop | Type | Description |
---|---|---|
user | User | null | The currently signed-in user, or null if there isn't any. |
Callback to receive the user's sign-in state change notifications.
(change: AuthStateChange): void
See CHANGELOG.md.
See LICENSE.
This plugin is based on the Capacitor Firebase Authentication plugin. Thanks to everyone who contributed to the project!
FAQs
Capacitor plugin for Firebase Authentication.
The npm package @capacitor-firebase/authentication receives a total of 9,601 weekly downloads. As such, @capacitor-firebase/authentication popularity was classified as popular.
We found that @capacitor-firebase/authentication demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.