summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/service/digitalassetlinks/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/android-components/components/service/digitalassetlinks/README.md')
-rw-r--r--mobile/android/android-components/components/service/digitalassetlinks/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/service/digitalassetlinks/README.md b/mobile/android/android-components/components/service/digitalassetlinks/README.md
new file mode 100644
index 0000000000..f130dfd7a5
--- /dev/null
+++ b/mobile/android/android-components/components/service/digitalassetlinks/README.md
@@ -0,0 +1,40 @@
+# [Android Components](../../../README.md) > Service > Digital Asset Links
+
+A library for communicating with the [Digital Asset Links](https://developers.google.com/digital-asset-links) API.
+
+## Usage
+
+### Setting up the dependency
+
+Use Gradle to download the library from [maven.mozilla.org](https://maven.mozilla.org/)
+([Setup repository](../../../README.md#maven-repository)):
+
+```Groovy
+implementation "org.mozilla.components:service-digital-asset-links:{latest-version}"
+```
+
+### Obtaining an AssetDescriptor
+
+For web sites, asset descriptors can be obtained by simply passing the origin into the `AssetDescriptor.Web` constructor.
+
+```kotlin
+AssetDescriptor.Web(
+ site = "https://{fully-qualified domain}{:optional port}"
+)
+```
+
+For Android apps, a fingerprint corresponding to the Android app must be used. This can be obtained using the `AndroidAssetFinder` class.
+
+### Remote API
+
+The `DigitalAssetLinksApi` class will handle checking asset links by calling [Google's remote API](https://developers.google.com/digital-asset-links/reference/rest). An API key must be given to the class.
+
+### Local API
+
+The `StatementRelationChecker` class will handle checking asset links on device by fetching and iterating through asset link statements located on a website. Either the `StatementApi` or `DigitalAssetLinksApi` classes may be used to obtain a statement list.
+
+## License
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/