Skip to content and Later

Changed prefix

All public entities now have the TKM (Tapkey Mobile) prefix.


The Tapkey service factory (and the Tapkey service factory builder) have been reworked to provide a simpler interface. All changes can be found in the table below.

Before From on
TkAnalyticsManager Removed
TkAsyncScheduler Removed
TkBleLockManager TKMBleLockScanner + TKMBleLockCommunicator
TkCloudMessagingManager Removed
TkCommandExecutionFacade TKMCommandExecutionFacade
TkConfigManager Removed
TkCookieManager Removed
TkDataContext Removed
TkDeviceManager Removed
TkFirmwareManager TKMFirmwareManager
TkIdentityProviderRegistration Removed
TkKeyManager TKMKeyManager
TkNotificationManager TKMNotificationManager
TkOwnerManager Removed
TkPollingManager Removed
TkPreferencesControlManager Removed
TkPreferencesManager Removed
TkRestHandler Removed
TkServerClock Removed
TkUriFactory Removed
TkUserManager TKMUserManager
TkUserSettings Removed
- TKMSupportManager


The BleLockManager class has been split into two separate components: A BLE lock scanner and a BLE lock communicator.

The BLE lock scanner (TKMBleLockScanner) provides means to scan for Tapkey locks via BLE. It can be used to scan for nearby locks and to determine whether a specific lock is nearby. Use TapkeyServiceFactory to retrieve an instance of BleLockScanner. Background scanning has been removed at all.

The BLE lock communicator (TKMBleLockCommunicator) provides means to communicate with Tapkey locks via BLE. It can be used to send commands to locks. Use TapkeyServiceFactory to retrieve an instance of BleLockCommunicator.


The key manager's interface has been simplified and only offers two members:

  • queryLocalKeysAsync(userId:forceUpdate:cancellationToken:)
  • keyUpdateObservable

Users and UserManager

Authentication has been reworked in the release. The SDK no longer handles users as complex objects. All methods that returned a User are now returning a String with the user's ID. All parameters that accepted a User are now accepting a String with the user's ID. Furthermore, authentication is no longer a part of the mobile SDK. Instead, the SDK takes a Tapkey access token to "log in" a user to the SDK instance on the present device. The reworked user manager (TKMUserManager) essentially provides the following two methods

  • logInAsync(accessToken:cancellationToken:)
  • logOutAsync(userId:cancellationToken:)

to handle user login and logout. This means that implementors have to obtain a Tapkey access token on their own, using one of the OAuth grant types supported by Tapkey. In most cases, this will be the Token Exchange grant type.

The SDK uses the token refresh handler (TKMTokenRefreshHandler) to request a new access token from the implementing application. The token refresh handler is passed to the SDK using TKMServiceFactoryBuilder#setTokenRefreshHandler(_:).


The Tapkey service factory builder exposes a new setter that accepts a token refresh handler as described above.


The new support manager exposes a method that will return information about the current SDK state that can be used for troubleshooting. Note that the information returned might contain sensitive data.