-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #99 from googlesamples/updatedocs
Update documentation snapshot
- Loading branch information
Showing
290 changed files
with
4,199 additions
and
3,223 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| <meta charset="utf-8"> | ||
| (#) Android App links should only use http(s) schemes | ||
|
|
||
| !!! ERROR: Android App links should only use http(s) schemes | ||
| This is an error. | ||
|
|
||
| Id | ||
| : `AppLinkSplitToWebAndCustom` | ||
| Summary | ||
| : Android App links should only use http(s) schemes | ||
| Severity | ||
| : Error | ||
| Category | ||
| : Correctness | ||
| Platform | ||
| : Android | ||
| Vendor | ||
| : Android Open Source Project | ||
| Feedback | ||
| : https://issuetracker.google.com/issues/new?component=192708 | ||
| Affects | ||
| : Manifest files | ||
| Editing | ||
| : This check runs on the fly in the IDE editor | ||
| See | ||
| : https://developer.android.com/training/app-links/verify-android-applinks#add-intent-filters | ||
| Implementation | ||
| : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/AppLinksValidDetector.kt) | ||
| Tests | ||
| : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AppLinksValidDetectorTest.kt) | ||
| Copyright Year | ||
| : 2017 | ||
|
|
||
| In order for Android App Links to open in your app, Android must perform | ||
| domain verification. However, Android only sends domain verification | ||
| requests for `<intent-filter>`s that only contain http(s) schemes. | ||
|
|
||
| To ensure correct behavior, please split your http(s) schemes and other | ||
| schemes into two different `<intent-filter>`s. | ||
|
|
||
| !!! Tip | ||
| This lint check has an associated quickfix available in the IDE. | ||
|
|
||
| (##) Example | ||
|
|
||
| Here is an example of lint warnings produced by this check: | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text | ||
| AndroidManifest.xml:7:Error: Split your http(s) and custom schemes into | ||
| separate intent filters [AppLinkSplitToWebAndCustom] | ||
| <intent-filter android:autoVerify="true" android:order="-1" android:priority="-1"> | ||
| ^ | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Here are the relevant source files: | ||
|
|
||
| `AndroidManifest.xml`: | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers | ||
| <manifest xmlns:android="http://schemas.android.com/apk/res/android" | ||
| package="com.example.helloworld" > | ||
| <uses-sdk android:minSdkVersion="31" android:targetSdkVersion="34" /> | ||
|
|
||
| <application> | ||
| <activity android:name=".SplitWebAndCustomActivity" android:exported="true"> | ||
| <intent-filter android:autoVerify="true" android:order="-1" android:priority="-1"> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
| <uri-relative-filter-group> | ||
| <data android:path="/path" /> | ||
| <data android:query="queryparam=value" /> | ||
| </uri-relative-filter-group> | ||
| <data android:scheme="http" /> | ||
| <data android:scheme="custom" /> | ||
| <data android:host="library.com" /> | ||
| <data android:path="@string/path" /> | ||
| <data android:path="/<&''" /> | ||
| <data android:path='/single"quote' /> | ||
| <data android:path="" /> | ||
| <!-- Test having tags underneath the host elements as well --> | ||
| <action android:name="android.intent.action.SEND"/> | ||
| <uri-relative-filter-group> | ||
| <data android:path="/path" /> | ||
| <data android:query="queryparam=value" /> | ||
| </uri-relative-filter-group> | ||
| </intent-filter> | ||
| </activity> | ||
| </application> | ||
| </manifest> | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| `res/values/strings.xml`: | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers | ||
| <resources> | ||
| <string name="path">/path</string> | ||
| </resources> | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| You can also visit the | ||
| [source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AppLinksValidDetectorTest.kt) | ||
| for the unit tests for this check to see additional scenarios. | ||
|
|
||
| The above example was automatically extracted from the first unit test | ||
| found for this lint check, `AppLinksValidDetector.test_splitToWebAndCustomSchemes`. | ||
| To report a problem with this extracted sample, visit | ||
| https://issuetracker.google.com/issues/new?component=192708. | ||
|
|
||
| (##) Suppressing | ||
|
|
||
| You can suppress false positives using one of the following mechanisms: | ||
|
|
||
| * Adding the suppression attribute | ||
| `tools:ignore="AppLinkSplitToWebAndCustom"` on the problematic XML | ||
| element (or one of its enclosing elements). You may also need to add | ||
| the following namespace declaration on the root element in the XML | ||
| file if it's not already there: | ||
| `xmlns:tools="http://schemas.android.com/tools"`. | ||
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <manifest xmlns:tools="http://schemas.android.com/tools"> | ||
| ... | ||
| <activity tools:ignore="AppLinkSplitToWebAndCustom" .../> | ||
| ... | ||
| </manifest> | ||
| ``` | ||
|
|
||
| * Using a special `lint.xml` file in the source tree which turns off | ||
| the check in that folder and any sub folder. A simple file might look | ||
| like this: | ||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <lint> | ||
| <issue id="AppLinkSplitToWebAndCustom" severity="ignore" /> | ||
| </lint> | ||
| ``` | ||
| Instead of `ignore` you can also change the severity here, for | ||
| example from `error` to `warning`. You can find additional | ||
| documentation on how to filter issues by path, regular expression and | ||
| so on | ||
| [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html). | ||
|
|
||
| * In Gradle projects, using the DSL syntax to configure lint. For | ||
| example, you can use something like | ||
| ```gradle | ||
| lintOptions { | ||
| disable 'AppLinkSplitToWebAndCustom' | ||
| } | ||
| ``` | ||
| In Android projects this should be nested inside an `android { }` | ||
| block. | ||
|
|
||
| * For manual invocations of `lint`, using the `--ignore` flag: | ||
| ``` | ||
| $ lint --ignore AppLinkSplitToWebAndCustom ...` | ||
| ``` | ||
|
|
||
| * Last, but not least, using baselines, as discussed | ||
| [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html). | ||
|
|
||
| <!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,225 @@ | ||
| <meta charset="utf-8"> | ||
| (#) App Link warning | ||
|
|
||
| !!! WARNING: App Link warning | ||
| This is a warning. | ||
|
|
||
| Id | ||
| : `AppLinkWarning` | ||
| Summary | ||
| : App Link warning | ||
| Severity | ||
| : Warning | ||
| Category | ||
| : Correctness | ||
| Platform | ||
| : Android | ||
| Vendor | ||
| : Android Open Source Project | ||
| Feedback | ||
| : https://issuetracker.google.com/issues/new?component=192708 | ||
| Affects | ||
| : Manifest files | ||
| Editing | ||
| : This check runs on the fly in the IDE editor | ||
| See | ||
| : https://developer.android.com/training/app-links | ||
| See | ||
| : https://g.co/AppIndexing/AndroidStudio | ||
| Implementation | ||
| : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/AppLinksValidDetector.kt) | ||
| Tests | ||
| : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AppLinksValidDetectorTest.kt) | ||
| Copyright Year | ||
| : 2017 | ||
|
|
||
| From Android 12, intent filters that use the HTTP and HTTPS schemes will | ||
| no longer bring the user to your app when the user clicks | ||
| a link, unless the intent filter is an Android App Link. | ||
| Such intent filters must include certain elements, and at least | ||
| one Android App Link for each domain must have | ||
| `android:autoVerify="true"` to verify ownership of the | ||
| domain. We recommend adding `android:autoVerify="true"` to any intent | ||
| filter that is intended to be an App Link, in case the other | ||
| App Links are modified. | ||
|
|
||
| !!! Tip | ||
| This lint check has an associated quickfix available in the IDE. | ||
|
|
||
| (##) Example | ||
|
|
||
| Here is an example of lint warnings produced by this check: | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text | ||
| AndroidManifest.xml:6:Warning: This intent filter has the format of an | ||
| Android App Link but is missing the autoVerify attribute; add | ||
| android:autoVerify="true" to ensure your domain will be validated and | ||
| enable App Link-related Lint warnings. If you do not want clicked URLs | ||
| to bring the user to your app, remove the | ||
| android.intent.category.BROWSABLE category, or set | ||
| android:autoVerify="false" to make it clear this is not intended to be | ||
| an Android App Link. [AppLinkWarning] | ||
| <intent-filter> <!-- We expect a warning here --> | ||
| ------------- | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Here is the source file referenced above: | ||
|
|
||
| `AndroidManifest.xml`: | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers | ||
| <manifest xmlns:android="http://schemas.android.com/apk/res/android" | ||
| package="com.example.helloworld" > | ||
|
|
||
| <application> | ||
| <activity android:name=".FullscreenActivity"> | ||
| <intent-filter> <!-- We expect a warning here --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:scheme="http" /> | ||
| <data android:scheme="https" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter> <!-- Missing VIEW --> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:scheme="http" /> | ||
| <data android:scheme="https" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter> <!-- Missing DEFAULT --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:scheme="http" /> | ||
| <data android:scheme="https" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter> <!-- Missing BROWSABLE --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
|
|
||
| <data android:scheme="http" /> | ||
| <data android:scheme="https" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter> <!-- Has custom scheme, missing http --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:scheme="other" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter> <!-- Has no scheme --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter> <!-- Missing host --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:scheme="http" /> | ||
| <data android:scheme="https" /> | ||
| </intent-filter> | ||
|
|
||
| <intent-filter android:autoVerify="false"> <!-- We would usually expect a warning here, but it has autoVerify="false" --> | ||
| <action android:name="android.intent.action.VIEW" /> | ||
| <category android:name="android.intent.category.DEFAULT" /> | ||
| <category android:name="android.intent.category.BROWSABLE" /> | ||
|
|
||
| <data android:scheme="http" /> | ||
| <data android:scheme="https" /> | ||
|
|
||
| <data android:host="example.com" /> | ||
| <data android:pathPrefix="/gizmos" /> | ||
| </intent-filter> | ||
| </activity> | ||
| </application> | ||
| </manifest> | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| You can also visit the | ||
| [source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AppLinksValidDetectorTest.kt) | ||
| for the unit tests for this check to see additional scenarios. | ||
|
|
||
| The above example was automatically extracted from the first unit test | ||
| found for this lint check, `AppLinksValidDetector.testAddAutoVerifySuggestion`. | ||
| To report a problem with this extracted sample, visit | ||
| https://issuetracker.google.com/issues/new?component=192708. | ||
|
|
||
| (##) Suppressing | ||
|
|
||
| You can suppress false positives using one of the following mechanisms: | ||
|
|
||
| * Adding the suppression attribute `tools:ignore="AppLinkWarning"` on | ||
| the problematic XML element (or one of its enclosing elements). You | ||
| may also need to add the following namespace declaration on the root | ||
| element in the XML file if it's not already there: | ||
| `xmlns:tools="http://schemas.android.com/tools"`. | ||
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <manifest xmlns:tools="http://schemas.android.com/tools"> | ||
| ... | ||
| <activity tools:ignore="AppLinkWarning" .../> | ||
| ... | ||
| </manifest> | ||
| ``` | ||
|
|
||
| * Using a special `lint.xml` file in the source tree which turns off | ||
| the check in that folder and any sub folder. A simple file might look | ||
| like this: | ||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <lint> | ||
| <issue id="AppLinkWarning" severity="ignore" /> | ||
| </lint> | ||
| ``` | ||
| Instead of `ignore` you can also change the severity here, for | ||
| example from `error` to `warning`. You can find additional | ||
| documentation on how to filter issues by path, regular expression and | ||
| so on | ||
| [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html). | ||
|
|
||
| * In Gradle projects, using the DSL syntax to configure lint. For | ||
| example, you can use something like | ||
| ```gradle | ||
| lintOptions { | ||
| disable 'AppLinkWarning' | ||
| } | ||
| ``` | ||
| In Android projects this should be nested inside an `android { }` | ||
| block. | ||
|
|
||
| * For manual invocations of `lint`, using the `--ignore` flag: | ||
| ``` | ||
| $ lint --ignore AppLinkWarning ...` | ||
| ``` | ||
|
|
||
| * Last, but not least, using baselines, as discussed | ||
| [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html). | ||
|
|
||
| <!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script> |
Oops, something went wrong.