Skip to content

docs(mobile): refresh iOS/Android SDK guides to the shipped 0.2.3 API#188

Merged
saltyskip merged 1 commit into
mainfrom
docs/mobile-sdk-refresh
Jun 3, 2026
Merged

docs(mobile): refresh iOS/Android SDK guides to the shipped 0.2.3 API#188
saltyskip merged 1 commit into
mainfrom
docs/mobile-sdk-refresh

Conversation

@saltyskip
Copy link
Copy Markdown
Owner

The mobile SDK guides had drifted from the actual API. Verified each change against the generated UniFFI bindings (rift_ffi.swift) and OrangeRock's real integration.

Fixes (stale → correct)

  1. reportAttributionForLinkattributeLink. That name doesn't exist in the bindings (0 occurrences); the real method is attributeLink(linkId:). Fixed in the iOS + Android API tables and the Android install-referrer / deferred snippets. (The lifecycle page already used the correct name — the pages disagreed.)
  2. parseClipboardLink(text:)parseClipboardLink(text:, allowedHosts:) — the host-validation arg shipped in 0.2.2.
  3. iOS minimum version — now stated as iOS 15 (matches Package.swift .v15 from fix(sdk): repair iOS pasteboard wrapper + compile Swift for iOS in CI (0.2.3) #187).

Alignment with real-world usage

  1. iOS install now recommends SPM via https://github.com/saltyskip/rift (how OrangeRock consumes it), with the tarball as a fallback.
  2. "Handle an incoming link" section added to both guides for the already-installed case — iOS .onOpenURL, Android App Link intent → attributeLink + getLink, mirroring OrangeRock's deep-link routing. (Deferred deep linking only covered the not-installed case.)
  3. iOS methods table now lists the recommended checkDeferredDeepLinkFromPasteboard(clearOnMatch:) alongside the lower-level checkDeferredDeepLink(clipboardText:).

Notes

  • Docs-only (marketing/src/app/docs/{ios-sdk,android-sdk,deferred}/page.tsx). Manually reviewed JSX for escaped entities; the marketing lint/build runs in its own pipeline (deps weren't installed in this worktree).
  • Unchanged because already current: the detectPatterns callout, setUserId/clearUserId/trackConversion signatures, storage notes.

🤖 Generated with Claude Code

The mobile guides had drifted from the actual SDK surface (verified against
the generated bindings and OrangeRock's real integration):

- `reportAttributionForLink` does not exist — the method is `attributeLink`.
  Fixed in the iOS + Android API tables and the Android install-referrer /
  deferred snippets (the lifecycle page already used the correct name).
- `parseClipboardLink(text:)` now takes `allowedHosts:` (shipped in 0.2.2).
- iOS guide: state the iOS 15 minimum and recommend SPM via the repo URL
  (how OrangeRock consumes it); keep the tarball as a fallback.
- iOS methods table: add the recommended `checkDeferredDeepLinkFromPasteboard`.
- Add a "Handle an incoming link" section to both guides for the
  already-installed case (iOS `.onOpenURL`, Android App Link intent →
  `attributeLink` + `getLink`), mirroring OrangeRock's deep-link routing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Jun 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
rift Ready Ready Preview, Comment Jun 3, 2026 2:38pm

Request Review

@saltyskip saltyskip merged commit 83545fa into main Jun 3, 2026
6 checks passed
@saltyskip saltyskip deleted the docs/mobile-sdk-refresh branch June 3, 2026 15:00
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