Mapeamento de SDK Mobile

OneSignal foi atualizado de um modelo centrado em dispositivo (Player ID) para um modelo centrado em usuário (OneSignal ID). Para orientação de migração, consulte o Guia de Migração do User Model.Para documentação sobre implementações legadas centradas em dispositivo, veja Versão 9.

Esta página mapeia nomes de métodos e propriedades entre os SDKs Player Model e User Model do OneSignal. Ela espelha o layout da Referência de SDK Cliente do Player Model original para familiaridade. Exemplos Swift ilustram as mudanças de API, mas nem sempre são amostras de trabalho completas. Consulte a documentação vinculada para exemplos em outras linguagens e detalhes completos de implementação.

Initializing OneSignal

`initWithLaunchOptions()`

Player Model Reference

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

User Model Reference

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

Debugging

`setLogLevel()`

Player Model Reference

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

User Model Reference

OneSignal.Debug.setLogLevel(.LL_VERBOSE)

External user IDs

`setExternalId()`

Player Model Reference

OneSignal.setExternalId("EXTERNAL_USER_ID")

User Model Reference

OneSignal.login("EXTERNAL_USER_ID")

`removeExternalUserId()`

Player Model Reference

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

User Model Reference

OneSignal.logout()

User data

`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` [Dropped]

OneSignal.getDeviceState().isSubscribed

User Model: N/A

`isPushDisabled` [Dropped]

OneSignal.getDeviceState().isPushDisabled

User Model: N/A

`setLanguage()`

OneSignal.setLanguage("es")

OneSignal.User.setLanguage("en")

Privacy

`setRequiresUserPrivacyConsent()`

OneSignal.setRequiresUserPrivacyConsent(true)

OneSignal.setConsentRequired(true)

`consentGranted()`

OneSignal.consentGranted(true)

OneSignal.setConsentGiven(true)

Location

`setLocationShared()`

OneSignal.setLocationShared(false)

OneSignal.Location.isShared = false

`isLocationShared()`

OneSignal.isLocationShared()

OneSignal.Location.isShared

`promptLocation()`

OneSignal.promptLocation()

OneSignal.Location.requestPermission()

Subscription observers

`addSubscriptionObserver()`

OneSignal.addSubscriptionObserver(subscriptionObserver)

OneSignal.User.pushSubscription.addObserver(pushSubscriptionObserver)

`removeSubscriptionObserver()`

OneSignal.removeSubscriptionObserver(subscriptionObserver)

OneSignal.User.pushSubscription.removeObserver(pushSubscriptionObserver)

Push notifications

`promptForPushNotifications()`

OneSignal.promptForPushNotifications()

OneSignal.Notifications.requestPermission()

`postNotification()` [Dropped]

OneSignal.postNotification()

User Model: N/A

`clearOneSignalNotifications()`

OneSignal.clearOneSignalNotifications()

OneSignal.Notifications.clearAll()

`disablePush()`

OneSignal.disablePush(true)

OneSignal.User.pushSubscription.optOut()

`unsubscribeWhenNotificationsAreDisabled()` [Dropped]

OneSignal.unsubscribeWhenNotificationsAreDisabled(false)

User Model: N/A

`setLaunchURLsInApp()` [Dropped]

OneSignal.setLaunchURLsInApp(true)

User Model: 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")

In-app messages

`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()` [Dropped]

OneSignal.getTriggerValueForKey("trigger_key");

User Model: 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)

Email

`setEmail()`

User Model 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()` [Dropped]

OneSignal.add(subscriptionObserver)

User Model: N/A

`getSMSId()` [Dropped]

OneSignal.Default.SMSSubscriptionState.smsUserId

User Model: 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")

Documentação de desenvolvedor

SDKs móveis

SDKs web

Live Activities

Configuração de Desktop & Watch

​Initializing OneSignal

​initWithLaunchOptions()

​Debugging

​setLogLevel()

​External user IDs

​setExternalId()

​removeExternalUserId()

​Tags

​sendTag()

​sendTags()

​getTags()

​deleteTag()

​deleteTags()

​User data

​notificationPermissionStatus

​userId

​hasNotificationPermission() / areNotificationsEnabled

​pushToken

​hasNotificationPermission

​isSubscribed [Dropped]

​isPushDisabled [Dropped]

​setLanguage()

​Privacy

​setRequiresUserPrivacyConsent()

​consentGranted()

​Location

​setLocationShared()

​isLocationShared()

​promptLocation()

​Subscription observers

​addSubscriptionObserver()

​removeSubscriptionObserver()

​Push notifications

​promptForPushNotifications()

​postNotification() [Dropped]

​clearOneSignalNotifications()

​disablePush()

​unsubscribeWhenNotificationsAreDisabled() [Dropped]

​setLaunchURLsInApp() [Dropped]

​registerForProvisionalAuthorization()

​setNotificationWillShowInForegroundHandler()

​setNotificationOpenedHandler()

​addPermissionObserver()

​removePermissionObserver()

​Live activities

​enterLiveActivity()

​exit()

​In-app messages

​addTrigger()

​addTriggers()

​removeTriggerForKey()

​removeTriggerForKeys()

​getTriggerValueForKey() [Dropped]

​inAppMessagesArePaused

​setInAppMessageLifecycleHandler()

​setInAppMessageClickHandler()

​Email

​setEmail()

​logoutEmail()

​SMS

​setSMSNumber()

​logoutSMSNumber()

​addSMSSubscriptionObserver() [Dropped]

​getSMSId() [Dropped]

​Outcomes

​sendOutcome()

​sendOutcomeWithValue()

​sendUniqueOutcome()

Initializing OneSignal

`initWithLaunchOptions()`

Debugging

`setLogLevel()`

External user IDs

`setExternalId()`

`removeExternalUserId()`

Tags

`sendTag()`

`sendTags()`

`getTags()`

`deleteTag()`

`deleteTags()`

User data

`notificationPermissionStatus`

`userId`

`hasNotificationPermission()` / `areNotificationsEnabled`

`pushToken`

`hasNotificationPermission`

`isSubscribed` [Dropped]

`isPushDisabled` [Dropped]

`setLanguage()`

Privacy

`setRequiresUserPrivacyConsent()`

`consentGranted()`

Location

`setLocationShared()`

`isLocationShared()`

`promptLocation()`

Subscription observers

`addSubscriptionObserver()`

`removeSubscriptionObserver()`

Push notifications

`promptForPushNotifications()`

`postNotification()` [Dropped]

`clearOneSignalNotifications()`

`disablePush()`

`unsubscribeWhenNotificationsAreDisabled()` [Dropped]

`setLaunchURLsInApp()` [Dropped]

`registerForProvisionalAuthorization()`

`setNotificationWillShowInForegroundHandler()`

`setNotificationOpenedHandler()`

`addPermissionObserver()`

`removePermissionObserver()`

Live activities

`enterLiveActivity()`

`exit()`

In-app messages

`addTrigger()`

`addTriggers()`

`removeTriggerForKey()`

`removeTriggerForKeys()`

`getTriggerValueForKey()` [Dropped]

`inAppMessagesArePaused`

`setInAppMessageLifecycleHandler()`

`setInAppMessageClickHandler()`

Email

`setEmail()`

`logoutEmail()`

SMS

`setSMSNumber()`

`logoutSMSNumber()`

`addSMSSubscriptionObserver()` [Dropped]

`getSMSId()` [Dropped]

Outcomes

`sendOutcome()`

`sendOutcomeWithValue()`

`sendUniqueOutcome()`