com.tomtom.sdk.personaldata:personal-data-common/com.tomtom.sdk.personaldata/PersonalData

PersonalData

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

Implementations of PersonalData enable easy access to personal data.

Personal data refers to personal locations (home/work/favorites), recent destinations routing and guidance, and potentially other data needed to create navigation applications that are "connected" to the users digital life. In a later increment vehicle information (spec and state) will be made available as well.

Functions

addUserProfileUpdatedListener

abstract fun addUserProfileUpdatedListener(listener: UserProfileUpdatedListener)

Adds an update listener to be notified of any changes to any of the data within the user profile.

clearUserProfile

abstract fun clearUserProfile(): Result<Unit, UserProfileFailure>

Clears the user profile synchronously from persistent storage.

abstract fun clearUserProfile(callback: UserProfileClearedCallback)

Clears the user profile asynchronously from persistent storage.

abstract override fun close()

Closes the PersonalData instance.

loadUserProfile

abstract fun loadUserProfile(): Result<UserProfile, UserProfileFailure>

Loads the user profile synchronously from persistent storage.

abstract fun loadUserProfile(callback: UserProfileCallback): Cancellable

Loads the user profile asynchronously from persistent storage.

removeUserProfileUpdatedListener

abstract fun removeUserProfileUpdatedListener(listener: UserProfileUpdatedListener)

Removes an update listener for changes to any of the data within the user profile.

storeUserProfile

abstract fun storeUserProfile(userProfile: UserProfile): Result<UserProfile, UserProfileFailure>

Stores the user profile with the changes provided synchronously to persistent storage.

abstract fun storeUserProfile(userProfile: UserProfile, callback: UserProfileCallback)

Stores the user profile with the changes provided asynchronously to persistent storage.