History

harvey186 fdc1766a8e add_swisscows_default		2023-12-25 17:33:24 +01:00
..
build	search_engine	2023-12-25 10:19:33 +01:00
src	add_swisscows_default	2023-12-25 17:33:24 +01:00
README.md	first commit	2023-11-28 09:10:03 +01:00
build.gradle	first commit	2023-11-28 09:10:03 +01:00
proguard-rules.pro	first commit	2023-11-28 09:10:03 +01:00

README.md

Digital Asset Links

A library for communicating with the Digital Asset Links API.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

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.

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. 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/