Plugin.Firebase
This is a wrapper library around the native Android and iOS Firebase Xamarin SDKs which includes cross-platform APIs for most of the Firebase features.
Supported features
Basic setup
- 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.
- 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.
- Add
[GoogleService-Info.plist|google-services.json]
file to your app project. - Set
[GoogleService-Info.plist|google-services.json]
build action behaviour to[Bundle Resource|GoogleServicesJson]
by Right clicking/Build Action.
.NET MAUI support
The new plugin version 1.2.0 now supports .NET MAUI applications with .NET 6
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="'$(TargetFramework)' == 'net6.0-android'">
<GoogleServicesJson Include="google-services.json" />
</ItemGroup>
<ItemGroup Condition="'$(TargetFramework)' == 'net6.0-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;
#else
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.FinishedLaunching((_,__) => {
CrossFirebase.Initialize();
return false;
}));
#else
events.AddAndroid(android => android.OnCreate((activity, _) =>
CrossFirebase.Initialize(activity)));
#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="'$(TargetFramework)' == 'net6.0-ios' OR '$(TargetFramework)' == 'net6.0-android'">
<PackageReference Include="Plugin.Firebase" Version="1.2.0" />
</ItemGroup>
Android specifics
- Add the following
ItemGroup
to your.csproj file
to prevent build errors:
<ItemGroup Condition="'$(TargetFramework)' == 'net6.0-android'">
<PackageReference Include="Xamarin.Kotlin.StdLib.Jdk7" Version="1.7.10" ExcludeAssets="build;buildTransitive" />
<PackageReference Include="Xamarin.Kotlin.StdLib.Jdk8" Version="1.7.10" ExcludeAssets="build;buildTransitive" />
</ItemGroup>
Take a look at the sample project to get more information.
Plugin.Firebase.Legacy
If you are working with an older Xamarin project and are not able to migrate to .NET MAUI yet, there is a legacy version of the plugin called Plugin.Firebase.Legacy. The code for this package is located on a branch called legacy
. Bugfixes or other small important changes can be done here and will be synced to the development/master
branch if needed.
Android specifics
- Add the following
PackageReference
to the.csproj file
of your android project to prevent a build error (see this github comment for more information):
<PackageReference Include="Xamarin.Google.Guava.ListenableFuture" Version="1.0.0.2" ExcludeAssets="build;buildTransitive" />
- If you receive an error that states the
default Firebase App is not initialized
, adding one package explicitly seems to resolve this issue (it doesn't seem to matter which package gets added).
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 Xamarin.Forms 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 Xamarin.Forms 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
.
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.
Contributions
You are welcome to contribute to this project by creating a Pull Request. The project contains an .editorconfig file that handles the code formatting, so please apply the formatting rules by running dotnet format src/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.
Release notes
- Version 2.0.*
- see docs of separate nuget packages
- Version 2.0.0
- All features have been split into separate nuget packages
- Cleaned up namespaces
- Enable usage of
DateTime
in Firestore #137 - Remove unnecessary dependency
Microsoft.CSharp
#143 - Fix fcm token refresh by adding
DidReceiveRegistrationToken
method toFirebaseCloudMessagingImplementation
- Version 1.3.0
- Get rid of newtonsoft.json, use system.text.json instead #119
- Add crashlytics implementation #120
- Add support for DateTime type to ToHashMap/Put extension #121
- Lazy google/facebook auth #122
- Return FIRAuthError.WrongPassword at android for wrong pw signin #117
- Calling completion in didReceiveNotificationResponse:completionHandler #106
- Big thanks to tranb3r for the contributions! :)