Skip to content

docs: add CNAME initialization examples for iOS and Android#87

Merged
jamesnrokt merged 2 commits into
mainfrom
feat/cname-support
Jun 9, 2026
Merged

docs: add CNAME initialization examples for iOS and Android#87
jamesnrokt merged 2 commits into
mainfrom
feat/cname-support

Conversation

@rmi22186

@rmi22186 rmi22186 commented May 20, 2026

Copy link
Copy Markdown
Member

Background

mParticle Flutter PR #73 added README examples for configuring a custom CNAME endpoint without any new Dart API — Flutter consumers initialise the mParticle SDK natively from their AppDelegate / Application class and wire MPNetworkOptions.customBaseURL / NetworkOptions.withNetworkOptions directly. React Native takes the same approach (no runtime JS bridge; only an Expo config plugin for build-time codegen). Cordova consumers initialise the same way, so a docs-only change matches.

What's changed

  • README iOS section: MPNetworkOptions.customBaseURL snippet (Swift + Objective-C) inserted after the standard init example.
  • README Android section: NetworkOptions.withNetworkOptions snippet (Java + Kotlin) inserted after the standard init example.
  • CHANGELOG.md [Unreleased] entry under Added.

No JS API, no native bridge changes, no dependency bumps.

🤖 Generated with Claude Code

@rmi22186 rmi22186 requested a review from a team as a code owner May 20, 2026 14:02
@cursor

cursor Bot commented May 20, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and changelog only; no runtime, bridge, or dependency changes.

Overview
Documents how Cordova apps configure a custom CNAME base URL during native mParticle startup (no new Cordova/JS API).

The README adds short sections after the standard iOS and Android init examples: MPNetworkOptions.customBaseURL (Swift and Objective-C) and NetworkOptions.withNetworkOptions (Java and Kotlin), with copy explaining Rokt SDK+ routing through your own domain. Android sample credentials placeholders are normalized to REPLACE_ME_WITH_*. CHANGELOG.md records the addition under [Unreleased].

Reviewed by Cursor Bugbot for commit eda07b8. Bugbot is set up for automated code reviews on this repo. Configure here.

Cordova consumers initialise the mParticle SDK natively from their
AppDelegate / Application class, so a custom CNAME endpoint is
configured the same way as in any non-Cordova app — via
`MPNetworkOptions.customBaseURL` on iOS or
`NetworkOptions.withNetworkOptions` on Android. No JS bridge needed.

Mirrors the docs portion of mParticle/mparticle-flutter-sdk#73.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rmi22186 rmi22186 force-pushed the feat/cname-support branch from 53c6af4 to 50e1573 Compare May 29, 2026 14:07
@rmi22186 rmi22186 changed the title docs: align native dependency versions for CNAME updates docs: add CNAME initialization examples for iOS and Android May 29, 2026
@rmi22186 rmi22186 changed the base branch from shoppable-ads to main May 29, 2026 14:10
@rmi22186

Copy link
Copy Markdown
Member Author

Docs only change, so build/test failure is not an issue - this should be fixed in shoppable-ads branch.

denischilik
denischilik previously approved these changes May 29, 2026
- Explain *why* to route the Rokt SDK+ through a custom domain (reduces the risk
  of ad blockers / browsers blocking ads or data) instead of the terse
  "Optional: if your team uses a custom CNAME endpoint" lead-in, on both the iOS
  (MPNetworkOptions) and Android (NetworkOptions) examples.
- Change the Android credential placeholders to REPLACE_ME_WITH_KEY /
  REPLACE_ME_WITH_SECRET so they select/copy-paste as single tokens.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jamesnrokt jamesnrokt merged commit acd476a into main Jun 9, 2026
11 checks passed
@jamesnrokt jamesnrokt deleted the feat/cname-support branch June 9, 2026 14:54
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.

3 participants