This page is archived and might not reflect the latest version of the FlutterFire plugins. You can find the latest information on firebase.google.com:
To receive the Firebase Dynamic Links that you created,
you must include the Dynamic Links SDK in your app and call the
FirebaseDynamicLinks.getDynamicLink() method when your app loads to
get the data passed in the Dynamic Link.
Install and initialize the Firebase SDKs for Flutter if you haven't already done so.
From the root direcctory of your Flutter project, run the following command to install the Dynamic Links plugin:flutter pub add firebase_dynamic_links
If you're building an Android app, open the Project settings page of the Firebase console and make sure you've specified your SHA-1 signing key. If you use App Links, also specify your SHA-256 key.
Complete the following platform integration steps for the platforms you're building your app for.
On Android, you must add a new intent filter catch deep links of your domain, since the
Dynamic Link will redirect to your domain if your app is installed. This is required for your app to
receive the Dynamic Link data after it is installed/updated from the Play Store and one taps on
Continue button. In
When users open a Dynamic Link with a deep link to the scheme and host you specify, your app will start the activity with this intent filter to handle the link.
Create an Apple developer account if you don't already have one.
On the Project settings page of the Firebase console, ensure that your iOS app is correctly configured with your App Store ID and Team ID.
On the Apple Developer site, create a provisioning profile for your app with the Associated Domain capability enabled.
In Xcode, do the following:
Open your app under the TARGETS header.
On the Signing & Capabilities page, ensure your Team is registered, and your Provisioning Profile is set.
Add the domain you created in the Firebase console to the Associated Domains, prefixed with
On the Info page, add a URL Type to your project. Set the URL Schemes field to your app's bundle ID. (The Identifier can be
Bundle IDor whatever you wish.)
If you have set up a custom domain for your Firebase project, add the Dynamic Link URL prefix into your iOS project's
Info.plistfile using the
FirebaseDynamicLinksCustomDomainskey.<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"><plist version="1.0"><dict><key>FirebaseDynamicLinksCustomDomains</key><array><string>https://custom.domain.io/path1</string><string>https://custom.domain.io/path2</string></array>...other settings</dict></plist>
Optional: Disable the Dynamic Links SDK's use of the iOS pasteboard.
By default, the Dynamic Links SDK uses the pasteboard to improve the reliablity of post-install deep links. By using the pasteboard, Dynamic Links can make sure that when a user opens a Dynamic Link but needs to install your app first, the user can go immediately to the original linked content when opening the app for the first time after installation.
The downside of this is that use of the pasteboard triggers a notification on iOS 14 and later. So, the first time users open your app, if the pasteboard contains a Dynamic Link URL, they will see a notification that your app accessed the pasteboard, which can cause confusion.
To disable this behavior, edit your Xcode project's
Info.plistfile and set the
When you disable this feature, the Dynamic Links you receive will have a
weakat best. Adjust your app's logic accordingly.
To handle a Dynamic Link in your application, two scenarios require implementing.
If the application is terminated, the
method allows you to retrieve the Dynamic Link that opened the application.
This is an asynchronous request, so it makes sense to handle a link before rendering application logic, such as
a navigator. For example, you could handle this in the
Within your application logic, you can then check whether a link was handled and perform an action, for example:
Alternatively, if you wish to identify if an exact Dynamic Link was used to open the application, pass it to
getDynamicLink method instead:
Whilst the application is open, or in the background, you may listen to Dynamic Links events using a stream handler. The
getter returns a
Stream containing a