-
Notifications
You must be signed in to change notification settings - Fork 0
CLAUDE
This directory is the published, public wiki for the Convert iOS SDK. It contains two categories of pages.
-
Shared docs (lowercase-hyphenated filenames, e.g.
rule-evaluation.md,data-management.md,segments.md,bucketing-algorithm.md, and everything listed under "Core Concepts (Shared)" / "How-To Guides (Shared)" inAI_Index.md) — these are the cross-SDK concept docs whose canonical source lives in a private backend repo (public/js/tracking/full-stack-docs/, withconcepts/andguides/subdirs). The same files appear in the JavaScript, Android, and PHP SDK wikis. The conceptual prose is shared; the code samples here have been adapted to Swift/iOS. If the iOS wiki is later added to the backend doc-sync, the prose portions may be regenerated — keep the iOS code adaptations minimal and self-contained. -
iOS-specific docs (CamelCase filenames, e.g.
Quickstart.md,Installation.md,Initialization.md,Configuration.md,ReturnTypes.md,CodeExamples.md,OfflineBehavior.md,TrackingControl.md,AppPrivacy.md,ObjCInterop.md,Testing.md) — these are iOS-only and are edited directly in this wiki.
- Check the filename.
- Lowercase-hyphenated → shared concept doc → prefer editing the canonical backend source; here, only adapt code samples to Swift.
- CamelCase → iOS-specific → edit here.
-
AI_Index.mdand thisCLAUDE.mdare wiki-specific and edited here.
The backend doc-sync workflow currently targets the JavaScript and PHP SDK wikis; the iOS wiki is not yet in its target matrix. The shared docs here were ported from the canonical source / the Android SDK wiki, with their relative links rewritten to this wiki's URLs and their code samples converted to Swift.
This wiki is public (as are the JavaScript, Android, and PHP SDK wikis). The backend wiki and backend repo are private. When writing or editing any iOS-specific doc here:
-
Never reference the private backend wiki or any private repo. No links to
backend.wiki/*, no "see the backend wiki." Inline what is needed, or omit it. -
Never reference internal backend filesystem paths. Use the public Swift surface: SPM (
https://github.com/convertcom/ios-sdk.git, productConvertSwiftSDK), CocoaPods (pod 'ConvertSwiftSDK'), module names (ConvertSwiftSDK,ConvertSwiftSDKCore), and type/method names. -
Never invent URLs. Guessed GitHub wiki URLs are a common failure — org, repo, slug, and casing are all easy to get wrong. Prefer the verified
convertcom/ios-sdk/wiki/...URLs already used across these pages. -
Prefer type and method references over file paths and line numbers.
ConvertSwiftSDK(configuration:)/ConvertContext.runExperience(_:enableTracking:)age better than aSources/...path. -
Ground every API claim in the actual SDK. Public types, method names, parameter names, defaults, and enum cases must match the released
ConvertSwiftSDKSwift API — not assumptions. The SDK uses an initializer (ConvertSwiftSDK(configuration:)), not a builder; returnsVariation/Feature(noBucketedprefix);GoalDatais a[GoalDataKey: GoalDataValue]dictionary; and completion-handler overloads exist only forready,runExperiences,setTrackingEnabled, andisTrackingEnabled.
Copyrights © 2026 All Rights Reserved by Convert Insights, Inc.
Getting Started
iOS SDK
- Quickstart
- Installation
- Initialization
- Configuration
- Return Types & Models
- Code Examples
- Offline Behavior
- Tracking Control
- App Privacy & Data Collection
- Objective-C Interop
Core Concepts
- Experiences & Variations
- Feature Flags
- Bucketing Algorithm
- Rule Evaluation
- Segments
- Data Management
- Event System
- API Communication
How-To Guides
- Running Experiences
- Running Features
- Tracking Conversions
- Visitor Context
- Persistent Storage
- Troubleshooting
Contributing