Skip to content

docs: Update iOS docs to reflect removal of legacy event methods #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update iOS docs to reflect removal of legacy event methods #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion guides/third-party-analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ You can also track events from the SDK via the PaywallDelegate or lifecycle meth
```swift
// ... rest of your delegate setup ...

func onHeliumPaywallEvent(_ event: any HeliumEvent) {
func onPaywallEvent(_ event: HeliumEvent) {
if let paywallOpen = event as? PaywallOpenEvent {
// e.g., forwarding to mixpanel
Mixpanel.mainInstance().track(
Expand Down
9 changes: 7 additions & 2 deletions sdk-reference/migration-2-to-3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,14 @@ The event system now uses protocol-based events with better type safety and IDE

#### Before v3

`onHeliumPaywallEvent(event:)` (deprecated but still works)
`onHeliumPaywallEvent(event:)` (removed)

<Warning>
The `onHeliumPaywallEvent(event:)` method has been removed from the iOS SDK. You must migrate to `onPaywallEvent(_:)`.
</Warning>

```swift
// ❌ No longer available
func onHeliumPaywallEvent(event: HeliumPaywallEvent) {
switch event {
case .paywallOpen(let trigger, let paywallTemplateName, _):
Expand Down Expand Up @@ -332,7 +337,7 @@ Helium.shared.initialize(

## Custom Paywall Traits

You can now pass custom paywall traits when displaying a paywall, replacing the deprecated `HeliumPaywallDelegate.getCustomVariableValues` method.
Pass custom paywall traits when displaying a paywall. The `HeliumPaywallDelegate.getCustomVariableValues` method has been removed from the iOS SDK.

```swift
Helium.shared.presentUpsell(
Expand Down