Integrating the Tapkey Mobile SDK for Android¶

repositories {
    maven { url "https://maven.tapkey.com" }
}

dependencies {
    implementation 'com.tapkey.android:Tapkey.MobileLib:2.44.0.0'
}

android {
    …
}

…

public class App extends Application implements TapkeyAppContext {

    /*
     * The TapkeyServiceFactory holds all required services.
     */
    private TapkeyServiceFactory tapkeyServiceFactory;

    @Override
    public void onCreate() {
        super.onCreate();

        /*
         * Create an instance of TapkeyServiceFactory. Tapkey expects that a single instance of
         * TapkeyServiceFactory exists inside an application that can be retrieved via the
         * Application instance's getTapkeyServiceFactory() method.
         */
        TapkeyServiceFactoryBuilder b = new TapkeyServiceFactoryBuilder(this);
        this.tapkeyServiceFactory = b.build();
    }

    @Override
    public TapkeyServiceFactory getTapkeyServiceFactory() {
        return tapkeyServiceFactory;
    }
}

<manifest … >
    …
    <uses-permission android:name="android.permission.INTERNET"/>
    <application … >
    …
</manifest>

UserManager userManager = tapkeyServiceFactory.getUserManager();
userManager.logInAsync("eyJhbGciOiJSUz…O-YbBq8F7086rQi-kEbERp4dA3r0WonpHnmYcXEnA", ct)
    .continueOnUi(userId -> {
        // User logged in, use user's ID here.
    });

String userId = userManager.getUsers().get(0);
// Fetch information about the user using the ID

// In Application.onCreate():
TapkeyServiceFactoryBuilder b = new TapkeyServiceFactoryBuilder();
b.setTokenRefreshHandler(new TokenRefreshHandler() {
    @Override
    public Promise<String> refreshAuthenticationAsync(String userId, CancellationToken ct) {
        PromiseSource res = new PromiseSource();

        asynchronouslyUpdateTheAccessTokenViaCustomAppLogic(
            newAccessToken -> res.setResult(newAccessToken),
            exception -> {
                if (isPersistentError(exception))
                    throw new TkException (AuthenticationHandlerErrorCodes.TokenRefreshFailed);
                else
                    res.setException(exception);
            }
        );

        return res.getPromise();
    }

    @Override
    public void onRefreshFailed(String userId) {
        /*
         * Will be called if re-authentication failed and a manual call to
         * updateAccessToken() is required.
         */
    }
});
this.tapkeyServiceFactory = b.build(this);

BleLockScanner scanner = tapkeyServiceFactory.getBleLockScanner();

// request permissions e.g. via ContextCompat.checkSelfPermission(...)

// Returns an observer registration to stop scanning once finished.
bleScanObserverRegistration = scanner.startForegroundScan();

// Listen for Tapkey locks coming into or leaving range.
nearbyLocksObserverRegistration = bleLockScanner.getLocksChangedObservable()
    .addObserver(locks -> {
        // Handle nearby locks here, e.g. present them to the user.
    });

// Alternatively, getLocks() can be used to get a list of nearby locks in this moment.
nearbyLocks = bleLockScanner.getLocks();

// The BLE lock manager establishes a connection to the lock which is passed to the
// CommandExecutionFacade to execute a trigger lock command.
return bleLockCommunicator.executeCommandAsync(
    bluetoothAddress, physicalLockId, tlcpConnection -> {

    // With the TlcpConnection to the lock established, the CommandExecutionFacade
    // asynchronously executes the trigger lock command.
    return commandExecutionFacade.triggerLockAsync(
        tlcpConnection,
        ct);
}, ct)
.continueOnUi(commandResult -> {
    switch (commandResult.getCommandResultCode()) {
        case Ok:
            return true;

        // Other cases must be handled here.
        …
    }

    // Let the user know, something went wrong.
    …
    return false;
})
.catchOnUi(e -> {
    Log.e(TAG, "Could not execute trigger lock command.", e);

    if (!ct.isCancellationRequested()) {
        // Handle any exceptions and let the user know, something went wrong.
        …
    }
    return false;
});

public class CustomLogger implements com.tapkey.mobile.utils.Logger {
    @Override
    public void println(int priority, String tag, String msg, Throwable tr) {
        // Custom logging implementation
    }
}

com.tapkey.mobile.utils.Logs.VERBOSE
com.tapkey.mobile.utils.Logs.DEBUG
com.tapkey.mobile.utils.Logs.INFO
com.tapkey.mobile.utils.Logs.WARN
com.tapkey.mobile.utils.Logs.ERROR

    @Override
    public void onCreate() {
        super.onCreate();

        com.tapkey.mobile.utils.Logs.setLogger(new CustomLogger());

        TapkeyServiceFactory tapkeyServiceFactory = new TapkeyServiceFactoryBuilder(this)
            ...
            .build();

        ...
    }