Mapeo de SDK móvil - OneSignal

OneSignal se ha actualizado de un modelo centrado en dispositivos (Player ID) a un modelo centrado en usuarios (OneSignal ID). Para orientación sobre migración, consulte la Guía de Migración del Modelo de Usuario.Para documentación sobre implementaciones heredadas centradas en dispositivos, consulte Versión 9.

Esta página mapea nombres de métodos y propiedades entre los SDKs del Modelo de Jugador y Modelo de Usuario de OneSignal. Refleja el diseño de la Referencia del SDK de Cliente del Modelo de Jugador original para familiaridad. Los ejemplos de Swift ilustran los cambios de API, pero no siempre son muestras de trabajo completas. Consulte la documentación vinculada para ejemplos en otros idiomas y detalles completos de implementación.

Inicializar OneSignal

`initWithLaunchOptions()`

Modelo de Jugador Referencia

OneSignal.initWithLaunchOptions(launchOptions)
OneSignal.setAppId("ONESIGNAL_APP_ID")

Modelo de Usuario Referencia

OneSignal.initialize("YOUR_ONESIGNAL_APP_ID", withLaunchOptions: launchOptions)

Depuración

`setLogLevel()`

Modelo de Jugador Referencia

OneSignal.setLogLevel(.LL_VERBOSE, visualLevel: .LL_NONE)

Modelo de Usuario Referencia

OneSignal.Debug.setLogLevel(.LL_VERBOSE)

IDs de usuario externos

`setExternalId()`

Modelo de Jugador Referencia

OneSignal.setExternalId("EXTERNAL_USER_ID")

Modelo de Usuario Referencia

OneSignal.login("EXTERNAL_USER_ID")

`removeExternalUserId()`

Modelo de Jugador Referencia

OneSignal.removeExternalUserId({ results in ... })

Modelo de Usuario Referencia

OneSignal.logout()

Etiquetas

`sendTag()`

Modelo de Jugador Referencia

OneSignal.sendTag("key", value: "value")

Modelo de Usuario Referencia

OneSignal.User.addTag(key: "key", value: "value")

`sendTags()`

OneSignal.sendTags(["key1": "value1", "key2": "value2"])

OneSignal.User.addTags(["key1": "value1", "key2": "value2"])

`getTags()`

OneSignal.getTags({ tags in ..., onFailure: { error in ... })

let tags = OneSignal.User.getTags()

`deleteTag()`

OneSignal.deleteTag("key")

OneSignal.User.removeTag("key")

`deleteTags()`

OneSignal.deleteTags(["key1", "key2"])

OneSignal.User.removeTags(["key1", "key2"])

Datos de usuario

`notificationPermissionStatus`

OneSignal.getDeviceState().notificationPermissionStatus

OneSignal.Notifications.permissionNative

`userId`

OneSignal.getDeviceState().userId

OneSignal.User.pushSubscription.id

`hasNotificationPermission()` / `areNotificationsEnabled`

OneSignal.getDeviceState().areNotificationsEnabled()

OneSignal.Notifications.permission

`pushToken`

OneSignal.getDeviceState().pushToken

OneSignal.User.pushSubscription.token

`hasNotificationPermission`

OneSignal.getDeviceState().hasNotificationPermission

OneSignal.User.pushSubscription.optedIn

`isSubscribed` [Eliminado]

OneSignal.getDeviceState().isSubscribed

Modelo de Usuario: N/A

`isPushDisabled` [Eliminado]

OneSignal.getDeviceState().isPushDisabled

Modelo de Usuario: N/A

`setLanguage()`

OneSignal.setLanguage("es")

OneSignal.User.setLanguage("en")

Privacidad

`setRequiresUserPrivacyConsent()`

OneSignal.setRequiresUserPrivacyConsent(true)

OneSignal.setConsentRequired(true)

`consentGranted()`

OneSignal.consentGranted(true)

OneSignal.setConsentGiven(true)

Ubicación

`setLocationShared()`

OneSignal.setLocationShared(false)

OneSignal.Location.isShared = false

`isLocationShared()`

OneSignal.isLocationShared()

OneSignal.Location.isShared

`promptLocation()`

OneSignal.promptLocation()

OneSignal.Location.requestPermission()

Observadores de suscripción

`addSubscriptionObserver()`

OneSignal.addSubscriptionObserver(subscriptionObserver)

OneSignal.User.pushSubscription.addObserver(pushSubscriptionObserver)

`removeSubscriptionObserver()`

OneSignal.removeSubscriptionObserver(subscriptionObserver)

OneSignal.User.pushSubscription.removeObserver(pushSubscriptionObserver)

Notificaciones push

`promptForPushNotifications()`

OneSignal.promptForPushNotifications()

OneSignal.Notifications.requestPermission()

`postNotification()` [Eliminado]

OneSignal.postNotification()

Modelo de Usuario: N/A

`clearOneSignalNotifications()`

OneSignal.clearOneSignalNotifications()

OneSignal.Notifications.clearAll()

`disablePush()`

OneSignal.disablePush(true)

OneSignal.User.pushSubscription.optOut()

`unsubscribeWhenNotificationsAreDisabled()` [Eliminado]

OneSignal.unsubscribeWhenNotificationsAreDisabled(false)

Modelo de Usuario: N/A

`setLaunchURLsInApp()` [Eliminado]

OneSignal.setLaunchURLsInApp(true)

Modelo de Usuario: N/A

`registerForProvisionalAuthorization()`

OneSignal.registerForProvisionalAuthorization({userResponse in ...})

OneSignal.Notifications.registerForProvisionalAuthorization({ userReponse in ... })

`setNotificationWillShowInForegroundHandler()`

OneSignal.setNotificationWillShowInForegroundHandler(foregroundHandler)

OneSignal.Notifications.addForegroundLifecycleListener(notificationLifecyleHandler)

`setNotificationOpenedHandler()`

OneSignal.setNotificationOpenedHandler(notificationOpenHandler)

OneSignal.Notifications.addClickListener(notificationClickListener)

`addPermissionObserver()`

OneSignal.addPermissionObserver(self as OSPermissionObserver)

OneSignal.Notifications.addPermissionObserver(notificationPermissionObserver)

`removePermissionObserver()`

OneSignal.removePermissionObserver()

OneSignal.Notifications.removePermissionObserver(notificationPermissionObserver)

Live activities

`enterLiveActivity()`

OneSignal.enterLiveActivity("my_activity_id", withToken: myToken)

OneSignal.LiveActivities.enter("my_activity_id", withToken: "TOKEN")

`exit()`

OneSignal.exitLiveActivity("my_activity_id")

OneSignal.LiveActivities.exit("my_activity_id")

Mensajes in-app

`addTrigger()`

OneSignal.addTrigger("prompt_ios", withValue: "true");

OneSignal.InAppMessages.addTrigger("KEY", withValue: "VALUE")

`addTriggers()`

OneSignal.addTriggers(["trigger_key_1": "1", "trigger_key_2": "some_other_value"])

OneSignal.InAppMessages.addTriggers(["trigger_key_1": "1", "trigger_key_2": "some_other_value"])

`removeTriggerForKey()`

OneSignal.removeTriggerForKey("trigger_key_1");

OneSignal.InAppMessages.removeTrigger("trigger_key_1")

`removeTriggerForKeys()`

OneSignal.removeTriggerForKeys(["trigger_key_1", "trigger_key_2"])

OneSignal.InAppMessages.removeTriggers(["trigger_key_1", "trigger_key_2"])

`getTriggerValueForKey()` [Eliminado]

OneSignal.getTriggerValueForKey("trigger_key");

Modelo de Usuario: N/A

`inAppMessagesArePaused`

OneSignal.inAppMessagesArePaused = true

OneSignal.InAppMessages.paused = true

`setInAppMessageLifecycleHandler()`

OneSignal.setInAppMessageLifecycleHandler(handler)

OneSignal.InAppMessages.addLifecycleListener(listener)

`setInAppMessageClickHandler()`

OneSignal.setInAppMessageClickHandler(clickHandler)

OneSignal.InAppMessages.addClickListener(clickListener)

Correo electrónico

`setEmail()`

Modelo de Usuario doc

OneSignal.setEmail("email@example.com")

OneSignal.User.addEmail("email@example.com")

`logoutEmail()`

OneSignal.logoutEmail()

OneSignal.User.removeEmail("email@example.com")

SMS

`setSMSNumber()`

OneSignal.setSMSNumber("+11234567890")

OneSignal.User.addSms("+11234567890")

`logoutSMSNumber()`

OneSignal.logoutSMSNumber()

OneSignal.User.removeSms("+11234567890")

`addSMSSubscriptionObserver()` [Eliminado]

OneSignal.add(subscriptionObserver)

Modelo de Usuario: N/A

`getSMSId()` [Eliminado]

OneSignal.Default.SMSSubscriptionState.smsUserId

Modelo de Usuario: N/A

Outcomes

`sendOutcome()`

OneSignal.sendOutcome("Purchase")

OneSignal.Session.addOutcome("Purchase")

`sendOutcomeWithValue()`

OneSignal.sendOutcomeWithValue(withValue: "Purchase", value: 18.76)

OneSignal.Session.addOutcome("Purchase", 18.76)

`sendUniqueOutcome()`

OneSignal.sendUniqueOutcome("Swipe")

OneSignal.Session.addUniqueOutcome("Swipe")

Modelo de usuario y guía de migración Mapeo de SDK web

⌘I