Skip to content

Latest commit

 

History

History
231 lines (169 loc) · 6.34 KB

USAGE.md

File metadata and controls

231 lines (169 loc) · 6.34 KB
Raw

How to use the iOS SDK v3

Setup

CocoaPods

pod "PostHog", "~> 3.0.0"

SPM

dependencies: [
  .package(url: "https://github.com/PostHog/posthog-ios.git", from: "3.0.0")
],

Examples

import PostHog

let config = PostHogConfig(apiKey: apiKey)
PostHogSDK.shared.setup(config)

Set a custom host (Self-Hosted)

let config = PostHogConfig(apiKey: apiKey, host: host)

Change the default configuration

let config = PostHogConfig(apiKey: apiKey)
config.captureScreenViews = false
config.captureApplicationLifecycleEvents = false
config.debug = true
// .. and more

If you don't want to use the global/singleton instance, you can create your own PostHog SDK instance and hold it

let config = PostHogConfig(apiKey: apiKey)
let postHog = PostHogSDK.with(config)

PostHogSDK.shared.capture("user_signed_up")

Enable or Disable the SDK to capture events

// During SDK setup
let config = PostHogConfig(apiKey: apiKey)
// the SDK is enabled by default
config.optOut = true
PostHogSDK.shared.setup(config)

// At runtime
PostHogSDK.shared.optOut()

// Check it and opt-in
if (PostHogSDK.shared.isOptOut()) {
    PostHogSDK.shared.optIn()
}

Capture a screen view event

let config = PostHogConfig(apiKey: apiKey)
// it's enabled by default
config.captureScreenViews = true
PostHogSDK.shared.setup(config)

// Or manually
PostHogSDK.shared.screen("Dashboard", properties: ["url": "...", "background": "blue"])

Capture an event

PostHogSDK.shared.capture("Dashboard", properties: ["is_free_trial": true])
// check out the `userProperties`, `userPropertiesSetOnce` and `groupProperties` parameters.

Identify the user

PostHogSDK.shared.identify("user123", userProperties: ["email": "user@PostHogSDK.shared.com"])

Create an alias for the current user

PostHogSDK.shared.alias("theAlias")

Identify a group

PostHogSDK.shared.group(type: "company", key: "company_id_in_your_db", groupProperties: ["name": "Awesome Inc."])

Registering and unregistering a context to be sent for all the following events

// Register
PostHogSDK.shared.register(["team_id": 22])

// Unregister
PostHogSDK.shared.unregister("team_id")

Load feature flags automatically

// Subscribe to feature flags notification
NotificationCenter.default.addObserver(self, selector: #selector(receiveFeatureFlags), name: PostHogSDK.didReceiveFeatureFlags, object: nil)
PostHogSDK.shared.setup(config)

The "receiveFeatureFlags" method will be called when the SDK receives the feature flags from the server.

// And/Or manually
PostHogSDK.shared.reloadFeatureFlags {
    if PostHogSDK.shared.isFeatureEnabled("paidUser") {
        // do something
    }
}

Read feature flags

let paidUser = PostHogSDK.shared.isFeatureEnabled("paidUser")

// Or
let paidUser = PostHogSDK.shared.getFeatureFlag("paidUser") as? Bool

Read feature flags variant/payload

let premium = PostHogSDK.shared.getFeatureFlagPayload("premium") as? Bool

Read the current distinctId

let distinctId = PostHogSDK.shared.getDistinctId()

Flush the SDK by sending all the pending events right away

PostHogSDK.shared.flush()

Reset the SDK and delete all the cached properties

PostHogSDK.shared.reset()

Close the SDK

PostHogSDK.shared.close()

Breaking changes

  • receivedRemoteNotification has been removed.
  • registeredForRemoteNotificationsWithDeviceToken has been removed.
  • handleActionWithIdentifier has been removed.
  • continueUserActivity has been removed.
  • openURL has been removed.
  • captureDeepLinks has been removed.
  • captureInAppPurchases has been removed.
  • capturePushNotifications has been removed.
  • shouldUseLocationServices config has been removed.
  • payloadFilters config has been removed.
  • shouldUseBluetooth config has been removed.
  • crypto config has been removed.
  • middlewares config has been removed.
  • httpSessionDelegate config has been removed.
  • requestFactory config has been removed.
  • shouldSendDeviceID config has been removed, events won't contain the $device_id attribute anymore.
  • launchOptions config has been removed, the Application Opened event won't contain the referring_application and url attributes anymore.
  • captureScreenViews is enabled by default (it does not work on SwiftUI)
  • captureApplicationLifecycleEvents is enabled by default

For the removed methods, you can use the PostHogSDK.shared.capture methods manually instead.

If any of the breaking changes are blocking you, please open an issue and let us know your use case.

iOS Session Recording

Enable Record user sessions on the PostHog project settings.

Requires the iOS SDK version >= 3.6.1.

Enable the SDK to capture Session Recording.

let config = PostHogConfig(apiKey: apiKey)
// sessionReplay is disabled by default
config.sessionReplay = true
// sessionReplayConfig is optional, they are enabled by default
config.sessionReplayConfig.maskAllTextInputs = true
config.sessionReplayConfig.maskAllImages = true
config.sessionReplayConfig.captureNetworkTelemetry = true
// screenshotMode is disabled by default
// The screenshot may contain sensitive information, use with caution
config.sessionReplayConfig.screenshotMode = true

If you don't want to mask everything, you can disable the mask config above and mask specific views using the ph-no-capture accessibilityIdentifier or accessibilityLabel.

Limitations

  • SwiftUI is only supported if the screenshotMode option is enabled.
  • It's a representation of the user's screen, not a video recording nor a screenshot.
    • Custom views are not fully supported.
    • If the option screenshotMode is enabled, the SDK will take a screenshot of the screen instead of making a representation of the user's screen.
  • WebView is not supported, a placeholder will be shown.
  • React Native and Flutter for iOS aren't supported.