iOS SDK setup

curl -X POST 'https://api.onesignal.com/notifications' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Authorization: Key YOUR_APP_API_KEY' \
  -d '{
    "app_id": "YOUR_APP_ID",
    "target_channel": "push",
    "name": "Testing basic setup",
    "headings": { "en": "👋" },
    "contents": {"en": "Hello world!"},
    "included_segments": ["Test Users"],
    "ios_attachments": {"onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"}
  }'

// Call when user logs in or is identified, safe to call multiple times
// Typically used in a login completion handler, or on app launch if already authenticated
func onUserAuthenticated(userId: String) {
    OneSignal.login(userId)
}

// If you want to remove the External ID from the Subscription, setting it to an anonymous user
func onUserLoggedOut() {
    OneSignal.logout()
}

// Add a tag when the user's name is set
OneSignal.User.addTag(key: "username", value: "john_doe")

// Create a custom event when user abandoned a cart
let myProperties = [
  "product_id": "123456",
  "product_name": "Product Name",
  "product_price": 100,
  "product_quantity": 1
]
OneSignal.User.trackEvent(name: "abandoned_cart", properties: myProperties as [String: Any])

// Add email subscription
// Call when user provides their email (e.g., account creation, settings update) after calling OneSignal.login("user_id")
OneSignal.User.addEmail("[email protected]")

// Add SMS subscription
// Use E.164 format: + country code + number
// Call when user provides their phone number (e.g., account creation, settings update) after calling OneSignal.login("user_id")
OneSignal.User.addSms("+15551234567")

// In AppDelegate, BEFORE OneSignal.initialize()
// Use this if your app requires GDPR or other privacy consent before data collection
OneSignal.setConsentRequired(true)

// Later, after user grants consent (e.g., taps "I Agree" on your consent screen)
OneSignal.setConsentGiven(true)

// The OSNotificationClickListener is used to detect push click events
class AppDelegate: NSObject, UIApplicationDelegate, OSNotificationClickListener {

  // Add the required onClick method for OSNotificationClickListener
  func onClick(event: OSNotificationClickEvent) {
    print("Notification clicked: \(event.jsonRepresentation())")
    let notification = event.notification
    // Access notification data
    let title = notification.title ?? ""
    let additionalData = notification.additionalData // Custom key-value pairs you sent
    // Example: Deep link based on custom data
    if let screenName = additionalData?["screen"] as? String {
        // Navigate to the specified screen
    }
  }

  // Reference the listeners in your AppDelegate
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    // For the OSNotificationClickListener
    OneSignal.Notifications.addClickListener(self)

    return true
  }
}

// The OSPushSubscriptionObserver is used to detect push subscription changes (token changes, opt-out, etc.)
class AppDelegate: NSObject, UIApplicationDelegate, OSNotificationPermissionObserver, OSPushSubscriptionObserver {

  // Add the onPushSubscriptionChanged method for OSPushSubscriptionObserver
  func onPushSubscriptionChanged(state: OSPushSubscriptionChangedState) {
    print("Push subscription changed: \(state.jsonRepresentation())")
    print(state.current.optedIn)
    print(state.current.token)
    // This is a good spot to update your UI or analytics
  }

  // Reference the observer in your AppDelegate
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    // For the OSPushSubscriptionObserver
    OneSignal.User.pushSubscription.addObserver(self)

    return true
  }
}

// The OSInAppMessageClickListener is used to detect in-app message button clicks
class AppDelegate: NSObject, UIApplicationDelegate, OSInAppMessageClickListener {
  // Add the onClick method for OSInAppMessageClickListener
  func onClick(event: OSInAppMessageClickEvent) {
    let result: OSInAppMessageClickResult = event.result
    print("In-app message clicked: \(result.jsonRepresentation())")
    let actionId = result.actionId
    print("Action ID: \(actionId ?? "no actionId")")
    // Example: Deep link based on the actionId
    if let screenName = actionId {
        // Navigate to the specified screen
    }
  }

  // Reference the listeners in your AppDelegate
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    // For the OSInAppMessageClickListener
    OneSignal.InAppMessages.addClickListener(self)

    return true
  }
}