👁 Image
Plugin.Firebase 4.2.1

Plugin.Firebase

This is a wrapper library around the native Android and iOS Firebase SDKs which includes cross-platform APIs for most of the Firebase features. Documentation and the included sample app are MAUI-centric, but the plugin should be usable in any cross-platform .NET9+ project.

v4.0 Upgrade Notes

• The experience of building projects using this plugin has been improved on Windows / Visual Studio. Issues related to hanging builds caused by XamarinBuildDownload and long path issues affecting iOS NuGet packages have been mitigated, if not commpletely resolved.
• MAUI-specific dependencies have been removed. This makes the plugin friendlier to non-MAUI mobile .NET projects.
  • Due to this change, it is now necessary to pass in an 'ActivityLocator' function when initializing the plugin on Android. (e.g., () => Platform.CurrentActivity)
• Minimum supported .NET version has been increased to .net9.0 (still compatible with .net10.0+)
• Mimimum supported iOS version has been increased to 15.
• Minimum supported Android version has been increased to 23.
• Minimum supported Firebase SDK versions have been increased to 12.5 (iOS) and BoM 33.0 (Android).
  • Due to this change, consumers should no longer need to explicitly manage AndroidX dependencies on latest MAUI 9 or 10. These could always be needed again in the future as MAUI dependencies shift, or due to conflicts with other plugins etc.

Removed Auth provider implementations (Facebook, Apple, Google)

The plugin remains compatible with these (and other) auth providers, but it is now the developers' responsibility to implement them by directly accessing the native SDKs per-platform.

For Google and Facebook, the existing v3 provider packages may or may not still work. If not, you may examine the source code of this project (< v4.0) to migrate the implementations into your own project. In either case, you should be aware that both of these provider implementations use deprecated native APIs and it is strongly recommended to migrate to modern native APIs.

For Apple, Android was never supported by this plugin, and platform code on the Apple side was just this method.

To properly use these providers (and others) with this plugin, the general approach is:

1. Acquire a Firebase Auth AuthCredential (Firebase.Auth.AuthCredential from Xamarin.Firebase.Auth (Android) or AdamE.Firebase.Auth(iOS)). This is the part that can differ wildly by platform / provider, and sometimes requires additional platform binding libraries which may or may not be available readily available on NuGet. Starting-point documentation for this is https://firebase.google.com/docs/auth
2. Pass the AuthCredential to the SignInWithCredential or LinkWithCredential methods of the native auth implementations (i.e., FirebaseAuth.DefaultInstance)

Since Plugin.Firebase uses the same FirebaseAuth.DefaultInstance objects internally, it will autmoatically pick up on the auth state changes from the native SDKs.

View the v4.0 pull request for more information.

Supported features

Basic setup

This plugin is a thin wrapper around the native Firebase binding packages, which are, in turn, wrappers around the native platform SDKs. As such, developers should not primarily rely on documentation in this plugin for Firebase project configuration or SDK usage. The official Firebase docs should be your primary Firebase resource.

1. Create a Firebase project in the Firebase Console, if you don't already have one. If you already have an existing Google project associated with your mobile app, click Import Google Project. Otherwise, click Create New Project.
2. Click Add Firebase to your [iOS|Android] app and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just download the config file.
3. Add [GoogleService-Info.plist|google-services.json] file to your app project.
4. Set [GoogleService-Info.plist|google-services.json] build action behaviour to [Bundle Resource|GoogleServicesJson] by Right clicking/Build Action.
5. IMPORTANT (iOS only) Check the Readme at AdamEssenmacher/GoogleApisForiOSComponents for additional setup steps that are required.
6. Additional setup instructions for individual components (e.g. Auth, Analytics, Firestore, etc.) are linked in the above table.

Dependency Management

The native Firebase SDKs for both Android and iOS have their own set of dependencies--some of which are shared by other common Google libraries. To maximize compatibility and give developers the flexibility to choose from a range of compatible native SDK versions, this plugin's NuGet configuration specifies version ranges for the native SDK binding libraries. When resolving dependencies, NuGet's standard behavior is to resolve minimum compatible versions. This ultimately means that developers are responsible for managing versions of the Firebase iOS/Android SDKs that are included in their projects. This is done by adding the appropriate AdamE.Firebase.iOS.* and Xamarin.Firebase.* NuGet package references to your project. This is not strictly required for the plugin to work, but it is recommended to ensure that you are using the latest versions of the Firebase SDKs, which may include bug fixes or performance improvements internal to the Firebase SDKs.

When new major versions of native SDKs are released, Plugin.Firebase may or may not be compatible with them. It depends on whether or not breaking API changes have been introduced. In such cases, please open an issue (or PR) and the plugin will be updated to support the new version.

The native binding packages are published using a versioning scheme [MAJOR].[MINOR].[PATCH].[REVISION]. The MAJOR, MINOR, and PATCH version numbers mirror the native Firebase SDK versions. The REVISION number is incremented if the bindings themselves are updated. (Note: On Android, a '1' is prefixed to the MAJOR version. For example, native Android SDK 24.1.0 is published as 124.1.0.)

iOS Dependencies

When selecting package versions for iOS, best practice is to make sure that the MAJOR and MINOR versions match across all packages (e.g. 11.8..). Then, for each package, select the latest PATCH.REVISION.

• AdamE.Firebase.iOS.Analytics
• AdamE.Firebase.iOS.Auth
• AdamE.Firebase.iOS.AppCheck
• AdamE.Firebase.iOS.CloudMessaging
• AdamE.Firebase.iOS.Core
• AdamE.Firebase.iOS.Crashlytics
• AdamE.Firebase.iOS.Firestore
• AdamE.Firebase.iOS.Functions
• AdamE.Firebase.iOS.RemoteConfig
• AdamE.Firebase.iOS.Storage

Android Dependencies

When selecting package versions for Android, best practice is to choose a Firebase BoM and select matching package versions for each dependency. As examples, if you wish to use BoM version 33.8.0, then you would want to select Xamarin.Firebase.Analytics v122.2.0 and Xamarin.Firebase.Auth v123.1.0.

• Xamarin.Firebase.Analytics
• Xamarin.Firebase.Auth
• Xamarin.Firebase.AppCheck
• Xamarin.Firebase.Messaging
• Xamarin.Firebase.Common
• Xamarin.Firebase.Crashlytics
• Xamarin.Firebase.Firestore
• Xamarin.Firebase.Functions
• Xamarin.Firebase.Config
• Xamarin.Firebase.Storage

MAUI Project Configuration

To get started add the GoogleService-Info.plist and the google-services.json files to the root folder of your project and include them in the .csproj file like this:

<ItemGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">
 <GoogleServicesJson Include="google-services.json" />
</ItemGroup>

<ItemGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios'">
 <BundleResource Include="GoogleService-Info.plist" />
</ItemGroup>

Initialize the plugin in your MauiProgram.cs like this:

using Plugin.Firebase.Auth;

#if IOS
using Plugin.Firebase.Core.Platforms.iOS;
#elif ANDROID
using Plugin.Firebase.Core.Platforms.Android;
#endif

public static class MauiProgram
{
 public static MauiApp CreateMauiApp()
 {
 return MauiApp
 .CreateBuilder()
 .UseMauiApp<App>()
 ...
 .RegisterFirebaseServices()
 .Build();
 }
 
 private static MauiAppBuilder RegisterFirebaseServices(this MauiAppBuilder builder)
 {
 builder.ConfigureLifecycleEvents(events => {
#if IOS
 events.AddiOS(iOS => iOS.WillFinishLaunching((_,__) => {
 CrossFirebase.Initialize(new CrossFirebaseSettings());
 return false;
 }));
#elif ANDROID
 events.AddAndroid(android => android.OnCreate((activity, _) =>
 CrossFirebase.Initialize(activity, () => Platform.CurrentActivity, CreateFirebaseSettings())));
#endif
 });
 
 builder.Services.AddSingleton(_ => CrossFirebaseAuth.Current);
 return builder;
 }
 
}

Ensure the ApplicationId in your .csproj file matches the bundle_id and package_name inside of the [GoogleService-Info.plist|google-services.json] files:

<ApplicationId>com.example.myapp</ApplicationId>

The plugin doesn't support Windows or Mac catalyst, so either remove their targets from your .csproj file or use preprocessor directives and MSBuild conditions, e.g:

<ItemGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios' OR Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'android'">
 <PackageReference Include="Plugin.Firebase" Version="4.0.0" />
</ItemGroup>

Take a look at the sample project to get more information.

Documentation and samples

In the docs folder you can find for every feature a designated readme file that describes the setup and usage of this feature or where to find more information.

In the sample folder you can find a sample MAUI project. This project serves as a base to play around with the plugin and to test features that are hard to test automatically (like Authentication or Cloud Messages). playground-functions is a Cloud Functions project and contains the code to enable sending Cloud Messages from the backend.

In the tests folder you can find a MAUI project that lets you run integration tests. You should definitely check out the *Fixture.cs files to learn how the plugin is supposed to work. All the tests should pass when they get executed on a real device.

In case you would like to run the sample or test project by yourself, you need to add the GoogleService-Info.plist and google-services.json files of your own firebase project and adapt the other config files like Info.plist, Entitlements.plist, AndroidManifest.xml.

For windows users

@coop-tim has created a .NET 8 sample project with a really good and extensive description. It's targeting iOS and Android with Firebase Cloud Messaging, Analytics and the relevant build pipelines to get them built and pushed into App Center. Definitely worth checking it out!

Using Firebase Local Emulator Suite

If you would like to use the Firebase Local Emulator Suite for your tests or rapid prototyping you can do so by following the steps of the Getting started guide and calling the UseEmulator(host, port) method of the desired firebase service before doing any other operations.

For example the Plugin.Firebase.IntegrationTests project is configured to be able to use the Cloud Firestore emulator. You can start the emulator with initial seed data by running firebase emulators:start --only firestore --import=test-data/. Uncomment the line CrossFirebaseFirestore.Current.UseEmulator("localhost", 8080); in IntegrationTestAppDelegate.cs or MainActivity.cs to let the test project know it should use the emulator. Now all firestore related tests should pass.

Troubleshooting

Windows + Visual Studio + iOS long path issue

Visual Studio and Windows both have issues with long paths. The issue is explained (along with best-known workarounds) here.

Contributions

You are welcome to contribute to this project by creating a Pull Request. See CONTRIBUTING.md and BUILDING.md for contribution and build guidance. The project contains an .editorconfig file that handles the code formatting, so please apply the formatting rules by running dotnet format Plugin.Firebase.sln in the console before creating a Pull Request (see dotnet-format docs or this video for more information).

License

Plugin.Firebase is released under the MIT license. See the LICENSE file for details.