docs(android-sdk): document App Links support for the redirect URI - #254
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Android SDK’s public integration contract and documentation to explicitly support using Android App Links (https) as redirect URIs (in addition to custom schemes), without changing runtime behavior.
Changes:
- Document App Links as an officially supported redirect option in the root README, including manifest-merging instructions and verification guidance.
- Update
signOutKDoc to be scheme-neutral and align it with App Links support. - Document
LogtoRedirectReceiverActivity’s fully qualified name as public API (manifest-referenced) in both KDoc and the SDK manifest comments.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds an App Links integration section describing assetlinks.json, intent filters, console registration, and verification. |
| android-sdk/android/src/main/kotlin/io/logto/sdk/android/LogtoClient.kt | Rewords signOut KDoc to remove the custom-scheme-only requirement. |
| android-sdk/android/src/main/kotlin/io/logto/sdk/android/auth/logto/LogtoRedirectReceiverActivity.kt | Notes the activity FQN is public API for manifest merging / App Links integration. |
| android-sdk/android/src/main/AndroidManifest.xml | Documents that apps may add App Links intent filters (or remove the built-in filter) via manifest merging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wangsijie
approved these changes
Jun 11, 2026
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.
Summary
Make App Links an officially supported redirect option, ahead of the v3 release. The SDK runtime is already scheme-agnostic (
isValidRedirectUriand the callback URI matching accepthttpsredirect URIs as-is), so this is a documentation/contract change only — no behavior change.assetlinks.json(including the Play App Signing fingerprint pitfall), declaring theautoVerifyintent filter on the SDK's receiver activity via manifest merging, console registration, the fallback-page responsibility, and verification viaadb shell pm get-app-links. Apps that do not use the custom scheme can drop the SDK's built-in filter with<intent-filter tools:node="removeAll" />, which also lifts thelogtoRedirectSchemeplaceholder requirement (manifest merging processestools:nodebefore placeholder substitution; verified against AGP 7.1.2).LogtoRedirectReceiverActivityis now documented as public API (apps reference it from their manifests), so renaming or moving it becomes a breaking change. Noted in its KDoc and in the SDK manifest comment.signOutclaimed the post sign-out redirect URI's scheme "must match thelogtoRedirectSchememanifest placeholder", which is not true for App Links; reworded to be scheme-neutral.Testing
Tested locally: built the sample app without defining
logtoRedirectSchemeand with an App Links filter declared (bothtools:node="replace"and<intent-filter tools:node="removeAll" />variants) and inspected the merged manifest — the SDK's attributes are inherited, the custom-scheme filter is removed, and thehttpsfilter withautoVerifyis in place.Checklist
.changeset🤖 Generated with Claude Code