Mapping SDK mobile - OneSignal

OneSignal est passé d’un modèle centré sur l’appareil (Player ID) à un modèle centré sur l’utilisateur (OneSignal ID). Pour obtenir des conseils de migration, consultez le Guide de migration du modèle utilisateur.Pour la documentation sur les implémentations héritées centrées sur l’appareil, voir Version 9.

Cette page établit une correspondance entre les noms de méthodes et de propriétés des SDK modèle Player et modèle utilisateur de OneSignal. Elle reprend la mise en page de la Référence SDK client du modèle Player originale pour plus de familiarité. Les exemples Swift illustrent les changements d’API, mais ne sont pas toujours des échantillons de travail complets. Consultez la documentation liée pour des exemples dans d’autres langages et des détails d’implémentation complets.

Initialisation de OneSignal

`initWithLaunchOptions()`

Modèle Player Référence

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

Modèle utilisateur Référence

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

Débogage

`setLogLevel()`

Modèle Player Référence

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

Modèle utilisateur Référence

OneSignal.Debug.setLogLevel(.LL_VERBOSE)

ID utilisateur externes

`setExternalId()`

Modèle Player Référence

OneSignal.setExternalId("EXTERNAL_USER_ID")

Modèle utilisateur Référence

OneSignal.login("EXTERNAL_USER_ID")

`removeExternalUserId()`

Modèle Player Référence

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

Modèle utilisateur Référence

OneSignal.logout()

Balises

`sendTag()`

Modèle Player Référence

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

Modèle utilisateur Référence

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"])

Données utilisateur

`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` [Supprimé]

OneSignal.getDeviceState().isSubscribed

Modèle utilisateur: N/A

`isPushDisabled` [Supprimé]

OneSignal.getDeviceState().isPushDisabled

Modèle utilisateur: N/A

`setLanguage()`

OneSignal.setLanguage("es")

OneSignal.User.setLanguage("en")

Confidentialité

`setRequiresUserPrivacyConsent()`

OneSignal.setRequiresUserPrivacyConsent(true)

OneSignal.setConsentRequired(true)

`consentGranted()`

OneSignal.consentGranted(true)

OneSignal.setConsentGiven(true)

Localisation

`setLocationShared()`

OneSignal.setLocationShared(false)

OneSignal.Location.isShared = false

`isLocationShared()`

OneSignal.isLocationShared()

OneSignal.Location.isShared

`promptLocation()`

OneSignal.promptLocation()

OneSignal.Location.requestPermission()

Observateurs d’abonnement

`addSubscriptionObserver()`

OneSignal.addSubscriptionObserver(subscriptionObserver)

OneSignal.User.pushSubscription.addObserver(pushSubscriptionObserver)

`removeSubscriptionObserver()`

OneSignal.removeSubscriptionObserver(subscriptionObserver)

OneSignal.User.pushSubscription.removeObserver(pushSubscriptionObserver)

Notifications push

`promptForPushNotifications()`

OneSignal.promptForPushNotifications()

OneSignal.Notifications.requestPermission()

`postNotification()` [Supprimé]

OneSignal.postNotification()

Modèle utilisateur: N/A

`clearOneSignalNotifications()`

OneSignal.clearOneSignalNotifications()

OneSignal.Notifications.clearAll()

`disablePush()`

OneSignal.disablePush(true)

OneSignal.User.pushSubscription.optOut()

`unsubscribeWhenNotificationsAreDisabled()` [Supprimé]

OneSignal.unsubscribeWhenNotificationsAreDisabled(false)

Modèle utilisateur: N/A

`setLaunchURLsInApp()` [Supprimé]

OneSignal.setLaunchURLsInApp(true)

Modèle utilisateur: 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")

Messages 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()` [Supprimé]

OneSignal.getTriggerValueForKey("trigger_key");

Modèle utilisateur: 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)

E-mail

`setEmail()`

Modèle utilisateur 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()` [Supprimé]

OneSignal.add(subscriptionObserver)

Modèle utilisateur: N/A

`getSMSId()` [Supprimé]

OneSignal.Default.SMSSubscriptionState.smsUserId

Modèle utilisateur: N/A

Résultats

`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")

Modèle utilisateur et guide de migration Mapping SDK web

⌘I