Skip to content

docs: lifecycle events + openURL public API [rn] (4/4)#37

Open
choudlet wants to merge 1 commit into
chrish/sc-36800/rn-lifecycle-pr3-client-wiringfrom
chrish/sc-36800/rn-lifecycle-pr4-docs
Open

docs: lifecycle events + openURL public API [rn] (4/4)#37
choudlet wants to merge 1 commit into
chrish/sc-36800/rn-lifecycle-pr3-client-wiringfrom
chrish/sc-36800/rn-lifecycle-pr4-docs

Conversation

@choudlet
Copy link
Copy Markdown
Collaborator

Summary

Slice 4 of 4 in the RN lifecycle stack (sc-36800). README documentation for the feature landed in PRs 1-3.

Stacked on #36. Review the diff against that branch.

Coverage

  • Lifecycle Events table — the four events with trigger conditions and emitted properties.
  • Opt-in framing — `trackLifecycleEvents` default flipped to `false`, code sample for enabling, opt-in callout in the Features list.
  • `openURL` public API — documented in the Analytics Interface section and a dedicated Deep-link wiring subsection with code samples (Linking forwarding, `sourceApplication` usage).
  • Buffer semantics — one-shot, last-write-wins, cleared on emit, no-op + warning when disabled.
  • Privacy & sanitization — worked example showing how a host can strip tokens / OTPs / magic-link secrets before forwarding (the SDK passes URLs verbatim).
  • Why no auto-instrumentation — no swizzling, no AppDelegate proxy, host-controlled hand-off via `openURL` (avoids conflicts with Firebase / Branch / etc., respects privacy, gives hosts control).
  • API Reference — `trackLifecycleEvents` default updated to `false`, Analytics Interface gains an `openURL` bullet.

Stack

  1. #34 — storage foundation
  2. #35 — emitter
  3. #36 — client wiring + `openURL` + opt-in default
  4. This PR — README documentation

Test plan

  • Markdown renders cleanly on GitHub (table, code blocks, anchors)
  • Internal anchor `#application-lifecycle-events` resolves from the TOC and from in-line cross-references

Adds full README coverage for the lifecycle feature landed in PRs 1-3
(sc-36800):

  - Table of the four events with trigger conditions + properties.
  - Opt-in framing — `trackLifecycleEvents` default flipped to `false`,
    code sample for enabling, opt-in callout in the Features list.
  - openURL public API documented under the Analytics Interface
    section and in a dedicated 'Deep-link wiring' subsection with code
    samples (Linking forwarding + sourceApplication usage).
  - Buffer semantics: one-shot, last-write-wins, cleared on emit,
    no-op + warning when feature is disabled.
  - Privacy + sanitization guidance with a worked example showing how
    a host can strip tokens / OTPs / magic-link secrets before
    forwarding (URLs are passed verbatim by the SDK).
  - 'Why no auto-instrumentation' rationale — no swizzling, no
    AppDelegate proxy, host-controlled hand-off via openURL.
  - API Reference: `trackLifecycleEvents` default updated to `false`,
    Analytics Interface gains an `openURL` bullet.

Slice 4 of 4 in the RN lifecycle stack (sc-36800).
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