unlockWithTap

An unlock scanning process that enables mobile apps to open granted entrances.

This class enables your app to use Bluetooth® Low Energy (BLE) to scan for nearby door readers and unlock authorized entrances. The app launches an unlock scanning process. When the user holds their phone close to the lock that they want to open, the phone communicates wirelessly with the lock and transmits access credentials. Once the lock verifies these credentials and confirms that access is granted, it unlocks.

First, launch UnlockWithTap. unlockWithTap automatically starts scanning whenever it is possible to scan and stops scanning whenever it is not possible to scan. That is, when an issue obstructs the phone from scanning, the canScan capability changes to false, and Seam adds the resulting error to the error list. Further, the error explains to the user how to fix the causing issue.

Use an SeamEventHandler to handle unlock-related status updates, such as ReaderGrantedAccess. Use these events to initiate changes to the user interface.

unlockWithTap continues attempting to scan, until you explicitly stop it. For example, you may want to disable scanning if the user changes the focus on their phone to a different app or after an unlock has been completed successfully.