app_links
Introduction: Android App Links, Deep Links, iOs Universal Links and Custom URL schemes handler for Flutter.
Tags:
Android App Links, Deep Links, iOS Universal Links and Custom URL schemes handler (desktop included).
This plugin allows you to:
- catch HTTPS URLs to open your app instead of the browser (App Link / Universal Link).
- catch custom schemes to open your app (Deep Link / Custom URL scheme).
Getting Started
Before using the plugin, you'll need to setup each platforms you target.
All those configurations below are accessible in the example project.
Android
- App Links: Documentation
- Deep Links: Documentation
iOS
- Universal Links: Documentation
- Custom URL schemes: Documentation
Windows
How to setup
Don't be afraid, this is just copy/paste commands to follow.But yes, it we will be a bit painful... Declare this method in
cpp
// Dispatches link if any.
// This method enables our app to be with a single instance too.
// This is mandatory if you want to catch further links in same app.
bool SendAppLinkToInstance(const std::wstring& title);
Add this inclusion in cpp
#include "app_links/app_links_plugin_c_api.h"
Add this method in cpp
bool Win32Window::SendAppLinkToInstance(const std::wstring& title) {
// Find our exact window
HWND hwnd = ::FindWindow(kWindowClassName, title.c_str());
if (hwnd) {
// Dispatch new link to current window
SendAppLink(hwnd);
// (Optional) Restore our window to front in same state
WINDOWPLACEMENT place = { sizeof(WINDOWPLACEMENT) };
GetWindowPlacement(hwnd, &place);
switch(place.showCmd) {
case SW_SHOWMAXIMIZED:
ShowWindow(hwnd, SW_SHOWMAXIMIZED);
break;
case SW_SHOWMINIMIZED:
ShowWindow(hwnd, SW_RESTORE);
break;
default:
ShowWindow(hwnd, SW_NORMAL);
break;
}
SetWindowPos(0, HWND_TOP, 0, 0, 0, 0, SWP_SHOWWINDOW | SWP_NOSIZE | SWP_NOMOVE);
SetForegroundWindow(hwnd);
// END Restore
// Window has been found, don't create another one.
return true;
}
return false;
}
Add the call to the previous method in CreateAndShow
cpp
bool Win32Window::CreateAndShow(const std::wstring& title,
const Point& origin,
const Size& size) {
if (SendAppLinkToInstance(title)) {
return false;
}
Destroy();
...
Great!
Now you can register your own scheme.On Windows, URL protocols are setup in the Windows registry. This package won't do it for you (and will never sorry).
You can achieve it with url_protocol inside you app.
But... The most relevant solution is to include those registry modifications into your installer to allow the unregistration.
Mac OS
How to setup
Add this XML chapter in yourmacos/Runner/Info.plist
inside <plist version="1.0"><dict>
chapter:
xml
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<!-- abstract name for this URL type (you can leave it blank) -->
<string>sample_name</string>
<key>CFBundleURLSchemes</key>
<array>
<!-- your schemes -->
<string>sample</string>
</array>
</dict>
</array>
Done!
AppLinks usage
Simpliest usage with a single stream
final _appLinks = AppLinks();
// Subscribe to all events when app is started.
// (Use allStringLinkStream to get it as [String])
_appLinks.allUriLinkStream.listen((uri) {
// Do something (navigation, ...)
});
Decomposed usage
final _appLinks = AppLinks();
// Get the initial/first link.
// This is useful when app was terminated (i.e. not started)
final uri = await _appLinks.getInitialAppLink();
// Do something (navigation, ...)
// Subscribe to further events when app is started.
// (Use stringLinkStream to get it as [String])
_linkSubscription = _appLinks.uriLinkStream.listen((uri) {
// Do something (navigation, ...)
});
...
// Maybe later. Get the latest link.
final uri = await _appLinks.getLatestAppLink();
Android notes:
- By default, flutter Activity is set with
android:launchMode="singleTop"
. This is perfectly fine and expected, but this launches another instance of your app, specifically for the requested view.
If you don't want this behaviour, you can setandroid:launchMode="singleInstance"
in yourAndroidManifest.xml
and avoid another flutter warmup.
Tests
The following commands will help you to test links.
Test on Android
adb shell am start -a android.intent.action.VIEW \
-d "sample://open.my.app/#/book/hello-world"
For App Links, you can also test it from Android Studio: Documentation.
Test on iOS
/usr/bin/xcrun simctl openurl booted "app://www.example.com/#/book/hello-world"
Test on windows & macOS
Open your browser and type in your address bar:
sample://foo/#/book/hello-world2