How to get One Signal user's unique player id in iOS?

Question

How to retrieve the OneSignal users' unique player id in iOS? I only found iOS SDK Setup in OneSignal Official Documentation.

Thanks if any suggestions are given.

score 39 · Accepted Answer · answered Jun 09 '17 at 03:06

You need to use OneSignal's observers such as OSSubscriptionObserver.

// Add OSSubscriptionObserver after UIApplicationDelegate
class AppDelegate: UIResponder, UIApplicationDelegate, OSSubscriptionObserver {

   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
      // Add your AppDelegate as an subscription observer
      OneSignal.add(self as OSSubscriptionObserver)
   }

   // After you add the observer on didFinishLaunching, this method will be called when the notification subscription property changes. 
   func onOSSubscriptionChanged(_ stateChanges: OSSubscriptionStateChanges!) {
      if !stateChanges.from.subscribed && stateChanges.to.subscribed {
         print("Subscribed for OneSignal push notifications!")
      }
      print("SubscriptionStateChange: \n\(stateChanges)")

      //The player id is inside stateChanges. But be careful, this value can be nil if the user has not granted you permission to send notifications. 
      if let playerId = stateChanges.to.userId {
         print("Current playerId \(playerId)")
      }
   }
}

For a better explanation, here is the documentation for addSubscriptionObserver

I think it's to hard for such thing. OneSignal should print player id in logs. — Timur Bernikovich, Jul 07 '17 at 09:43
in my case ononOSSubscriptionChanged not called. Please suggest why it is not called still objserver is add in didFinishLaunching method. — Protocol, Mar 13 '19 at 05:34

score 27 · Answer 2 · answered Feb 28 '18 at 09:25

27

I do need to get the Player Id (Or UserId) somewhere inside my code, and i dont want to save it anywhere.

I ended up using this code:

let userId = OneSignal.getPermissionSubscriptionState().subscriptionStatus.userId

answered Feb 28 '18 at 09:25

MBH

16,271
19
99
149

Hi @MBH, when I used the your code let userId = OneSignal.getPermissionSubscriptionState().subscriptionStatus.userId , I am getting the following error "MUST PROVIDE A VALID CALLBACK" – Venkatesh Somu Oct 16 '18 at 04:49

score 2 · Answer 3 · answered Nov 28 '22 at 12:37

2

This is what worked for me because the other solutions are deprecated:

let userId = OneSignal.getDeviceState().userId

Make sure you import OneSignal:

import OneSignal

answered Nov 28 '22 at 12:37

Donat Kabashi

384
4
10

score 1 · Answer 4 · answered Feb 22 '20 at 10:10

    let status: OSPermissionSubscriptionState = OneSignal.getPermissionSubscriptionState()

    let hasPrompted = status.permissionStatus.hasPrompted
    print("hasPrompted = \(hasPrompted)")
    let userStatus = status.permissionStatus.status
    print("userStatus = \(userStatus)")

    let isSubscribed = status.subscriptionStatus.subscribed
    print("isSubscribed = \(isSubscribed)")
    let userSubscriptionSetting = status.subscriptionStatus.userSubscriptionSetting
    print("userSubscriptionSetting = \(userSubscriptionSetting)")
    let userID = status.subscriptionStatus.userId // This one
    print("userID = \(userID)")
    let pushToken = status.subscriptionStatus.pushToken
    print("pushToken = \(pushToken)")

score 0 · Answer 5 · answered Oct 24 '22 at 15:07

On WebViewGold-based apps on iOS (WKWebView / UIWebView) in combination with OneSignal ,you might need a little bit of back-end work to connect it to our OneSignal API: You should save the ?onesignal_push_id=XYZ parameter in a database, and fire the OneSignal API (https://documentation.onesignal.com/docs/onesignal-api) for that specific user as soon as a push notification should be sent. This has to be done by your back-end/webserver. WebViewGold only offers the built-in OneSignal API and the ability to deliver the ?onesignal_push_id=XYZ appendix to your WebView URL call.

So activate the „kPushEnhanceUrl“ option in Config.swift (by switching the value from false to true) to append the individual user ID via ?onesignal_push_id=XYZ to your WebView URL.

If your WebView URL is https://www.example.org, WebViewGold will call https://www.example.org?onesignal_push_id=XYZ instead. Only your FIRST URL request will get that GET variable, so save it in a session or in a cookie to access it on your linked pages. An alternative or additional way would be to retrieve & process the information on any page via JavaScript:

<script>

window.location.href = "getonesignalplayerid://";

alert(onesignalplayerid);

</script>

score -1 · Answer 6 · answered Mar 01 '23 at 22:08

-1

An even better solution right now is to use:

OneSignal.appId()

answered Mar 01 '23 at 22:08

Julian van Heek

52
4

This is a unique application id inside the OneSignal platform. – Sajjad Sarkoobi Aug 17 '23 at 02:14

score -8 · Answer 7 · answered Sep 21 '17 at 07:35

-8

You can find it inside of standardUserDefaults. You can retrieve it using the following. I believe it is set at the first app launch, however, it might not be set the first time application:didFinishLaunchingWithOptions: is called.

UserDefaults.standard.string(forKey: "GT_PLAYER_ID")

You can see what else is stored in user defaults by looking at the dictionary representation: UserDefaults.standard.dictionaryRepresentation()

answered Sep 21 '17 at 07:35

michaellindahl

2,012
5
36
64

Nice Answer actually OneSignal store player id by default into sharePrefrence (Android) and UserDefaults (ioS) – Kashif Ahmed Feb 24 '20 at 14:53

How to get One Signal user's unique player id in iOS?

7 Answers7