Skip to content

Commit

Permalink
feat(docs): Add more docs for configuring Android App Links
Browse files Browse the repository at this point in the history
  • Loading branch information
mlynch committed Jul 18, 2019
1 parent ee0e43a commit 76f6624
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions site/docs-md/android/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ You probably also want to set the Activity name to match the App, for apps that
<string name="title_activity_main">MyApp</string>
```

## 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.
Expand All @@ -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 `<manifest>` tag, generally at the bottom
Expand Down

0 comments on commit 76f6624

Please sign in to comment.