Mapping SDK web - 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.

Vue d’ensemble

Ce document établit une correspondance entre les méthodes, propriétés et événements du SDK web modèle Player hérité de OneSignal et le SDK modèle utilisateur plus récent. Chaque section inclut des exemples de code TypeScript correspondants, démontrant clairement comment mettre à jour votre intégration. Tous les exemples sont simplifiés à des fins de démonstration. Pour des implémentations complètes et à jour, consultez les liens de documentation fournis sous chaque méthode ou événement.

Service worker OneSignal

Mettez à jour l’import dans votre fichier OneSignalSDKWorker.js : Modèle Player :

importScripts('https://cdn.onesignal.com/sdks/OneSignalSDKWorker.js');

Modèle utilisateur :

importScripts("https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.sw.js");

Conservez le même chemin de fichier. Mettez simplement à jour l’URL importScripts. Voir Service worker OneSignal pour plus d’informations.

Initialisation

`init()`

Modèle Player : Docs

<script src="https://cdn.onesignal.com/sdks/OneSignalSDK.js" async></script>
<script>
window.OneSignal = window.OneSignal || [];
OneSignal.push(function() {
  OneSignal.init({
    appId: "YOUR_APP_ID"
  });
});
</script>

Modèle utilisateur : Docs

<script src="https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js" defer></script>
<script>
window.OneSignalDeferred = window.OneSignalDeferred || [];
OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.init({
    appId: "YOUR_APP_ID",
  });
});
</script>

`provideUserConsent()`

Modèle Player : Docs

OneSignal.provideUserConsent(true)

Modèle utilisateur : Docs

OneSignal.setConsentGiven(true)

Inscription aux notifications push

`showNativePrompt()`

Modèle Player :

OneSignal.showNativePrompt()

Modèle utilisateur : Docs

OneSignal.Notifications.requestPermission()

`registerForPushNotifications()` — Supprimé dans le modèle utilisateur

OneSignal.registerForPushNotifications()

`#permissionPromptDisplay`

Modèle Player :

OneSignal.on('permissionPromptDisplay', () => ...)

Modèle utilisateur : Docs

OneSignal.Notifications.addEventListener('permissionPromptDisplay', event => { ... })

`showSlidedownPrompt()`

Modèle Player :

OneSignal.showSlidedownPrompt()

Modèle utilisateur : Docs

OneSignal.Slidedown.promptPush()

`showHttpPrompt()` — Supprimé dans le modèle utilisateur

OneSignal.showHttpPrompt()

`showCategorySlidedown()`

Modèle Player :

OneSignal.showCategorySlidedown()

Modèle utilisateur : Docs

OneSignal.Slidedown.promptPushCategories()

`#getNotificationPermission`

Modèle Player :

OneSignal.on('getNotificationPermission', (permission) => ...)

Modèle utilisateur : Docs

OneSignal.User.PushSubscription.addEventListener('change', ({ optedIn }) => { ... })

`isPushNotificationsSupported()`

Modèle Player :

OneSignal.isPushNotificationsSupported()

Modèle utilisateur : Docs

OneSignal.Notifications.isPushSupported()

`isPushNotificationsEnabled()`

Modèle Player :

await OneSignal.isPushNotificationsEnabled()

Modèle utilisateur : Docs

OneSignal.User.PushSubscription.optedIn

`#subscriptionChange`

Modèle Player :

OneSignal.on('subscriptionChange', (subscribed) => ...)

Modèle utilisateur :

OneSignal.User.PushSubscription.addEventListener('change', ({ token }) => { ... })

Analytique

`#notificationPermissionChange`

Modèle Player :

OneSignal.on('notificationPermissionChange', ({ to }) => ...)

Modèle utilisateur : Docs

OneSignal.Notifications.addEventListener('permissionChange', permission => { ... })

`#popoverShown`

Modèle Player :

OneSignal.on('popoverShown', () => ...)

Modèle utilisateur : Docs

OneSignal.Slidedown.addEventListener('slidedownShown', presented => { ... })

`#customPromptClick`

Modèle Player :

OneSignal.on('customPromptClick', ({ result }) => ...)

Modèle utilisateur : Docs

OneSignal.Notifications.addEventListener('click', ({notification, result}) => { ... })

ID utilisateur

`getUserId()`

Modèle Player :

OneSignal.getUserId()

Modèle utilisateur : Docs

OneSignal.User.PushSubscription.id;

`setExternalUserId()`

Modèle Player : Docs

OneSignal.setExternalUserId("external id")

Modèle utilisateur : Docs

OneSignal.login("external id")

`removeExternalUserId()`

Modèle Player :

OneSignal.removeExternalUserId()

Modèle utilisateur : Docs

OneSignal.logout()

`getExternalUserId()`

Modèle Player :

await OneSignal.getExternalUserId()

Modèle utilisateur : Docs

OneSignal.User.externalId

Balises

`sendTag()`

Modèle Player :

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

Modèle utilisateur :

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

Modèle utilisateur doc

`sendTags()`

Modèle Player :

OneSignal.sendTags({ key1: 'value1', key2: 'value2' })

Modèle utilisateur :

OneSignal.User.addTags({ key1: 'value1', key2: 'value2' })

`getTags()`

Modèle Player :

await OneSignal.getTags()

Modèle utilisateur :

OneSignal.User.getTags()

`deleteTag()`

Modèle Player :

OneSignal.deleteTag("key")

Modèle utilisateur :

OneSignal.User.removeTag("key")

`deleteTags()`

Modèle Player :

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

Modèle utilisateur :

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

Notifications push

`sendSelfNotification()` — Supprimé dans le modèle utilisateur

OneSignal.sendSelfNotification('title', 'message', 'url')

`setSubscription()`

Modèle Player :

OneSignal.setSubscription(false)

Modèle utilisateur :

OneSignal.Notifications.permission = false

Réception des notifications

`#notificationDisplay`

Modèle Player :

OneSignal.on('notificationDisplay', (event) => { ... })

Modèle utilisateur :

OneSignal.Notifications.addEventListener('foregroundWillDisplay', ({ notification }) => { ... })

`#notificationDismiss`

Modèle Player :

OneSignal.on('notificationDismiss', (event) => { ... })

Modèle utilisateur :

OneSignal.Notifications.addEventListener('dismiss', ({ notification }) => { ... })

`#addListenerForNotificationOpened`

Modèle Player :

OneSignal.on('addListenerForNotificationOpened', (event) => { ... })

E-mail

`setEmail()`

Modèle utilisateur doc Modèle Player :

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

Modèle utilisateur :

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

`logoutEmail()`

Modèle Player :

OneSignal.logoutEmail()

Modèle utilisateur :

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

`getEmailId()` — Supprimé dans le modèle utilisateur

SMS

`setSMSNumber()`

Modèle Player :

OneSignal.setSMSNumber('+11234567890')

Modèle utilisateur :

OneSignal.User.addSms('+11234567890')

`logoutSMSNumber()`

Modèle Player :

OneSignal.logoutSMS()

Modèle utilisateur :

OneSignal.User.removeSms('+11234567890')

​Vue d’ensemble

​Service worker OneSignal

​Initialisation

​init()

​provideUserConsent()

​Inscription aux notifications push

​showNativePrompt()

​registerForPushNotifications() — Supprimé dans le modèle utilisateur

​#permissionPromptDisplay

​showSlidedownPrompt()

​showHttpPrompt() — Supprimé dans le modèle utilisateur

​showCategorySlidedown()

​#getNotificationPermission

​isPushNotificationsSupported()

​isPushNotificationsEnabled()

​#subscriptionChange

​Analytique

​#notificationPermissionChange

​#popoverShown

​#customPromptClick

​ID utilisateur

​getUserId()

​setExternalUserId()

​removeExternalUserId()

​getExternalUserId()

​Balises

​sendTag()

​sendTags()

​getTags()

​deleteTag()

​deleteTags()

​Notifications push

​sendSelfNotification() — Supprimé dans le modèle utilisateur

​setSubscription()

​Réception des notifications

​#notificationDisplay

​#notificationDismiss

​#addListenerForNotificationOpened

​E-mail

​setEmail()

​logoutEmail()

​getEmailId() — Supprimé dans le modèle utilisateur

​SMS

​setSMSNumber()

​logoutSMSNumber()

Vue d’ensemble

Service worker OneSignal

Initialisation

`init()`

`provideUserConsent()`

Inscription aux notifications push

`showNativePrompt()`

`registerForPushNotifications()` — Supprimé dans le modèle utilisateur

`#permissionPromptDisplay`

`showSlidedownPrompt()`

`showHttpPrompt()` — Supprimé dans le modèle utilisateur

`showCategorySlidedown()`

`#getNotificationPermission`

`isPushNotificationsSupported()`

`isPushNotificationsEnabled()`

`#subscriptionChange`

Analytique

`#notificationPermissionChange`

`#popoverShown`

`#customPromptClick`

ID utilisateur

`getUserId()`

`setExternalUserId()`

`removeExternalUserId()`

`getExternalUserId()`

Balises

`sendTag()`

`sendTags()`

`getTags()`

`deleteTag()`

`deleteTags()`

Notifications push

`sendSelfNotification()` — Supprimé dans le modèle utilisateur

`setSubscription()`

Réception des notifications

`#notificationDisplay`

`#notificationDismiss`

`#addListenerForNotificationOpened`

E-mail

`setEmail()`

`logoutEmail()`

`getEmailId()` — Supprimé dans le modèle utilisateur

SMS

`setSMSNumber()`

`logoutSMSNumber()`