From 76f66241b1051bdd6cf9c41589567aff68e6c169 Mon Sep 17 00:00:00 2001 From: Max Lynch Date: Thu, 18 Jul 2019 12:12:05 -0500 Subject: [PATCH] feat(docs): Add more docs for configuring Android App Links --- site/docs-md/android/configuration.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/site/docs-md/android/configuration.md b/site/docs-md/android/configuration.md index 5adf0233b..46df7cba2 100644 --- a/site/docs-md/android/configuration.md +++ b/site/docs-md/android/configuration.md @@ -37,6 +37,12 @@ You probably also want to set the Activity name to match the App, for apps that MyApp ``` +## Deeplinks (aka Android App Links) + +To enable deeplinking through Android App Links, follow the official Android guide on [Adding Android App Links](https://developer.android.com/studio/write/app-link-indexing). Android Studio comes with a handy wizard for configuring App Links. + +Once configured, the [getLaunchUrl in the App API](../../apis/app#method-getLaunchUrl-0) will provide any URL the app was launched with, and the [appUrlOpen event](../../apis/app#method-addListener-1) will fire any time the app receives a new App Link deeplink. + ## Changing Custom URL Your app can respond to custom URLs on launch, making it possible to handle deeplinks and app interactions. @@ -49,6 +55,8 @@ To change the URL, search for and modify this line in `strings.xml`. It's recomm In this example, the app will respond to URLs with the `com.getcapacitor.myapp://` scheme. +To get any custom URL the app may have launched with, see the Deeplinks section above this one. + ## Setting Permissions In Android, permissions your app will need are defined in `AndroidManifest.xml` inside of the `` tag, generally at the bottom