An opaque token that represents the current user’s iCloud Drive Documents identity.
- iOS 6.0+
- macOS 10.8+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
In iCloud Drive Documents, when iCloud is available, this property contains an opaque object representing the identity of the current user. If iCloud is unavailable or there is no logged-in user, the value of this property is
nil. Accessing the value of this property is relatively fast, so you can check the value at launch time from your app’s main thread.
You can use the token in this property, together with the
NSUbiquity notification, to detect when the user logs in or out of iCloud and to detect changes to the active iCloud account. When the user logs in with a different iCloud account, the identity token changes, and the system posts the notification. If you stored or archived the previous token, compare that token to the newly obtained one using the
is method to determine if the users are the same or different.
Accessing the token in this property doesn’t connect your app to its ubiquity containers. To establish access to a ubiquity container, call the
url(for method. In macOS, you can instead use an
NSDocument object, which establishes access automatically.