Repository navigation
docs: correct KDoc for attributionMethod, LinkFortyConfig and the setup example - #22
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.
…up example - DeepLinkData and InstallResponse: attributionMethod can be "install_referrer", and matchedFactors is ["install_referrer"] then. - LinkFortyConfig: the app token is required on the hosted service; the API key is needed only for createLink and is a secret. - LinkForty class example: use https://api.linkforty.com with an appToken. - Describe the hosted service generically in comments, README, llms.txt, e2e/README and an older CHANGELOG entry, and drop a ticket reference from a test comment.
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.
Builds on #21. This PR targets
docs/readme-accuracy; once #21 merges it will retarget tomain.Comments and docs only. No code changes.
Changes
DeepLinkData.attributionMethod/InstallResponse.attributionMethod: the KDoc listed only"fingerprint"(and"none"). Core also returns"install_referrer"when the Play install referrer names the click, and SDK 1.8.0 sends that referrer.matchedFactorsis documented to include["install_referrer"]in that case.LinkFortyConfig:apiKeywas described as "for LinkForty Cloud authentication", andappTokenas "Optional… Recommended". NowapiKeyis described as needed only forcreateLink(): it is sent as a Bearer token when set, and it is a secret.appTokenis described as required on the hosted service and not needed by a self-hosted Core server.baseURLnameshttps://api.linkforty.comand the HTTP-allowed local hosts. The organic-install example said "App Store"; it now says "Play Store".LinkFortyclass example:go.yourdomain.com+apiKeyis replaced withhttps://api.linkforty.com+appToken, matching the README.DeviceFingerprint.ktandAttributionManager.ktcomments,README.md,llms.txt,e2e/README.mdand the 1.2.0 CHANGELOG entry now describes the hosted service generically. A ticket reference is dropped from a test comment.Verified
./gradlew :sdk:compileReleaseKotlin :sdk:testDebugUnitTestsucceeds: 205 unit tests, 0 failures.