Repository navigation
docs: correct setup, config and privacy details in README, API.md and llms.txt - #21
Merged
Merged
Conversation
… llms.txt - Initialize against the hosted API host (https://api.linkforty.com) with an appToken, which the hosted service requires; apiKey is only for createLink() and is a secret. - Add a config field table, the Maven Central repository, and the coroutine requirement for initialize() and the tracking calls. - App Links: android:exported="true" and launchMode="singleTask" in the manifest sample, setIntent() in onNewIntent, how assetlinks.json is served, the Play App Signing fingerprint, and pm verify-app-links / get-app-links. - createLink(): against a Core server the fallback POST /api/links needs an originalUrl the SDK doesn't send. - Privacy: replace "probabilistic fingerprinting only / no persistent IDs" with what the code does (Play install referrer, stored install ID), list the data each request sends and the install referrer permission the dependency adds. - API.md: attributionMethod can be "install_referrer"; appToken/apiKey wording. - llms.txt: version 1.1.0 -> 1.8.0, drop the GitHub Packages repository (the SDK is on Maven Central), fix the hosted base URL and the claim that all methods work identically on a self-hosted server.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation only: no code, Gradle or version changes. Each fix was checked against the 1.8.0 source (
origin/main=v1.8.0).README
baseURLand calledappToken"recommended". It now uses the hosted API host (https://api.linkforty.com) and says the hosted service requiresappToken.apiKeyis dropped from the init sample, because it is a secret needed only bycreateLink(). Added a field table (LinkFortyConfig.kt: HTTPS rule incl.0.0.0.0, window 1–2160 h), the retry-on-failure behavior ofinitialize(), the full imports, and the Maven Central repository.initialize,trackEvent,trackRevenue,trackScreenViewandcreateLinkaresuspendfunctions that throwNotInitializedbeforeinitialize()finishes. The README now says so.android:exported="true"(required for targetSdk 31+) andlaunchMode="singleTask", soonNewIntent()fires.setIntent()was added inonNewIntent. The lookup rule now names thebaseURLhost (LinkDomains.isLinkFortyUrl).ANDROID_PACKAGE_NAME/ANDROID_SHA256_FINGERPRINTSon Core. Builds that use Play App Signing need the app signing key's SHA-256. The "Verify Digital Asset Links" command only opened a link. The test section now usespm verify-app-links --re-verify/pm get-app-links.POST /api/linkson a server without/api/sdk/v1/links. Core's/api/linksrequiresoriginalUrl, whichCreateLinkOptionsdoesn't send. The old "No API key needed for self-hosted" note is removed, since the SDK throwsMissingApiKeywithout one.BIND_GET_INSTALL_REFERRER_SERVICEpermission thatinstallreferrer2.2 adds (normal permission, no prompt).API.md
attributionMethodcan also be"install_referrer". Updated theappToken/apiKey/baseURLdescriptions and the init example.llms.txt
1.1.0→1.8.0. Dropped the GitHub Packages repository block: the SDK is published to Maven Central (seeRELEASING.md).createLink).initialize()no longer says it must come before any other method: callbacks andhandleDeepLinkcan be called first.Samples were checked against the source, not compiled.