Skip to content

README: 0.1.0 linking, consent and delivery docs - #24

Merged
ahsanalidotme merged 1 commit into
mainfrom
docs/readme-0.1.0
Oct 27, 2026
Merged

ahsanalidotme merged 1 commit into
mainfrom
docs/readme-0.1.0

Conversation

@ahsanalidotme

Copy link
Copy Markdown
Contributor

Docs only (README.md). Follow-up to #21, which merged and shipped as 0.1.0 before these README fixes were ready, so they go in a separate PR. The npm README updates on the next publish; GitHub shows it on merge.

Changes

  • iOS link wiring: AppDelegate must forward open url and continue userActivity to RCTLinkingManager, or Universal Links open the app but onLink never fires. Swift (RN 0.77+) and Objective-C (RN 0.76) snippets, matching example/ios/KickFlip/AppDelegate.swift. Android App Links filter added too.
  • linkDomains: required for custom domains from 0.1.0 (*.linktrail.io always claimed), with an upgrade snippet. Quick start now shows it. Custom schemes are described as the app's own routing.
  • configure singleton: same key/options is a no-op; different options replace the native instance; JS subscriptions stay valid (the bridge re-registers its native callbacks in every configure).
  • Deferred link delivery: native saves the link, delivers at least once, 7-day expiry, handler should be idempotent. In 0.1.0 the wrapper registers native onLink inside configure and doesn't buffer for a late JS listener, so the README says to subscribe before configure (the buffering lands in Wrapper parity 0.1.1: link buffering, camelCase errors, version #23).
  • Consent: table of the 0.1.0 outcomes. Undecided = held, nothing sent; denied = one consent: false install with no device id (routes, records nothing); setConsent(false) wins even with requireConsent: false.
  • Paste button: the tap goes through the native paste button, sends the install and records consent only while undecided; don't call trackInstallWithClickToken from onTokenPasted.
  • resetForTesting: one paragraph.

Conflicts with #23 (it also edits README.md). Whichever merges second needs a small rebase; #23 should then replace the 'subscribe before configure' paragraph with its buffering behaviour.

Impact

No DB changes, no code changes. Docs only; no production impact.

Add the iOS AppDelegate RCTLinkingManager wiring (open url and continue
userActivity, Swift and Objective-C) and the Android App Links filter.
Document linkDomains as required for custom domains with an upgrade
snippet, the configure singleton, deferred link delivery (at least once,
7-day expiry, subscribe before configure), resetForTesting, the 0.1.0
consent outcomes (deny sends one consent:false install) and how the
paste button handles consent.
@ahsanalidotme
ahsanalidotme marked this pull request as ready for review October 27, 2026 20:01
@ahsanalidotme
ahsanalidotme merged commit dcfb0b0 into main Oct 27, 2026
7 checks passed
@ahsanalidotme
ahsanalidotme deleted the docs/readme-0.1.0 branch October 27, 2026 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant