public interface CommandExecutionFacade
The example below outlines a
possible usage of triggerLockAsync(TlcpConnection, CancellationToken)
. In the present
example, the required TLCP connection is established using the
BleLockCommunicator
.
// The Bluetooth Communicator establishes a connection to the Tapkey lock via Bluetooth and lets // the CommandExecutionFacade use this connection to execute a TriggerLock command. return bleLockCommunicator.executeCommandAsync(bluetoothAddress, physicalLockId, tlcpConnection -> { // Now, with the TlcpConnection to the lock available, the CommandExecutionFacade // asynchronously executes the trigger lock command. return commandExecutionFacade.triggerLockAsync(tlcpConnection, ct); }, ct).continueOnUi(commandResult -> { switch (commandResult.getCommandResultCode()) { case Ok: return true; // Handle error results. ... } 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; });
Modifier and Type | Interface and Description |
---|---|
static interface |
CommandExecutionFacade.FirmwareUpgradeProgress
Reserved for internal use.
|
Modifier and Type | Method and Description |
---|---|
Promise<SyncLockCommandResult> |
bindLockAsync(String userId,
String ownerId,
TlcpConnection lock,
boolean force,
Integer timeoutMillis,
Action1<Float,RuntimeException> progress,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<net.tpky.mc.tlcp.model.RebindCommand.ResponseData> |
bindLockLocalAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<CommandResult> |
changeAdminModeAsync(TlcpConnection lock,
net.tpky.mc.model.CryptArtifacts cryptArtifacts,
net.tpky.mc.model.TkLockMode lockMode,
net.tpky.mc.model.AdminModeOperationType operationType,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<CommandResult> |
deactivateAdminModeAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<CommandResult> |
executeCustomCommandAsync(TlcpConnection lock,
boolean asUnauthenticatedCommand,
int manufacturerId,
int customCommandId,
byte[] data,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<Void> |
executeCustomCommandSimpleAsync(TlcpConnection lock,
boolean asUnauthenticatedCommand,
int manufacturerId,
int customCommandId,
byte[] data,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<net.tpky.mc.tlcp.model.GetCustomCommandsDescriptorCommand.ResponseData> |
getCustomCommandDescriptorsAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<PublicStateInfo> |
queryPublicStateAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<CommandResult> |
setLockTimeAsync(TlcpConnection lock,
long timeOffset,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<CommandResult.CommandResultCode> |
syncLockOfflineAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<SyncLockCommandResult> |
syncLockOnlineAsync(String userId,
TlcpConnection lock,
Integer timeoutMillis,
Action1<Float,RuntimeException> progress,
CancellationToken cancellationToken)
Synchronizes the lock.
|
Promise<CommandResult> |
triggerLockAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Triggers the lock.
|
Promise<CommandResult> |
unbindLockLocalAsync(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<SyncLockCommandResult> |
unbindLockOnlineAsync(TlcpConnection lock,
Integer timeoutMillis,
Action1<Float,RuntimeException> progress,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<Void> |
upgradeFirmware(TlcpConnection lock,
FirmwarePackage firmwarePackage,
int firstChunkIdx,
Action1<CommandExecutionFacade.FirmwareUpgradeProgress,RuntimeException> progress,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<Void> |
uploadFirmware(TlcpConnection lock,
FirmwarePackage firmwarePackage,
int firstChunkIdx,
Action1<CommandExecutionFacade.FirmwareUpgradeProgress,RuntimeException> progress,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<Void> |
waitForTagLost(net.tpky.nfc.NdefConnection tag,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<Void> |
waitForTagLost(TlcpConnection lock,
CancellationToken cancellationToken)
Reserved for internal use.
|
Promise<CommandResult> triggerLockAsync(TlcpConnection lock, CancellationToken cancellationToken)
lock
- the TLCP connection to the lock.cancellationToken
- a token to handle cancel events.CommandResult.getCommandResultCode()
,
CommandResult.CommandResultCode
Promise<CommandResult.CommandResultCode> syncLockOfflineAsync(TlcpConnection lock, CancellationToken cancellationToken)
Promise<SyncLockCommandResult> syncLockOnlineAsync(String userId, TlcpConnection lock, Integer timeoutMillis, Action1<Float,RuntimeException> progress, CancellationToken cancellationToken)
userId
- the user's ID.lock
- the TLCP connection to the lock.timeoutMillis
- a timeout in milliseconds.progress
- a progress indicator reporting the operation's progress between 0 and 100.cancellationToken
- a token to handle cancel events.Promise<PublicStateInfo> queryPublicStateAsync(TlcpConnection lock, CancellationToken cancellationToken)
Promise<CommandResult> changeAdminModeAsync(TlcpConnection lock, net.tpky.mc.model.CryptArtifacts cryptArtifacts, net.tpky.mc.model.TkLockMode lockMode, net.tpky.mc.model.AdminModeOperationType operationType, CancellationToken cancellationToken)
Promise<CommandResult> deactivateAdminModeAsync(TlcpConnection lock, CancellationToken cancellationToken)
Promise<CommandResult> setLockTimeAsync(TlcpConnection lock, long timeOffset, CancellationToken cancellationToken)
Promise<CommandResult> unbindLockLocalAsync(TlcpConnection lock, CancellationToken cancellationToken)
Promise<SyncLockCommandResult> unbindLockOnlineAsync(TlcpConnection lock, Integer timeoutMillis, Action1<Float,RuntimeException> progress, CancellationToken cancellationToken)
Promise<SyncLockCommandResult> bindLockAsync(String userId, String ownerId, TlcpConnection lock, boolean force, Integer timeoutMillis, Action1<Float,RuntimeException> progress, CancellationToken cancellationToken)
Promise<net.tpky.mc.tlcp.model.RebindCommand.ResponseData> bindLockLocalAsync(TlcpConnection lock, CancellationToken cancellationToken)
Promise<Void> upgradeFirmware(TlcpConnection lock, FirmwarePackage firmwarePackage, int firstChunkIdx, Action1<CommandExecutionFacade.FirmwareUpgradeProgress,RuntimeException> progress, CancellationToken cancellationToken)
Promise<Void> uploadFirmware(TlcpConnection lock, FirmwarePackage firmwarePackage, int firstChunkIdx, Action1<CommandExecutionFacade.FirmwareUpgradeProgress,RuntimeException> progress, CancellationToken cancellationToken)
Promise<net.tpky.mc.tlcp.model.GetCustomCommandsDescriptorCommand.ResponseData> getCustomCommandDescriptorsAsync(TlcpConnection lock, CancellationToken cancellationToken)
Promise<CommandResult> executeCustomCommandAsync(TlcpConnection lock, boolean asUnauthenticatedCommand, int manufacturerId, int customCommandId, byte[] data, CancellationToken cancellationToken)
Promise<Void> executeCustomCommandSimpleAsync(TlcpConnection lock, boolean asUnauthenticatedCommand, int manufacturerId, int customCommandId, byte[] data, CancellationToken cancellationToken)
Promise<Void> waitForTagLost(net.tpky.nfc.NdefConnection tag, CancellationToken cancellationToken)
Promise<Void> waitForTagLost(TlcpConnection lock, CancellationToken cancellationToken)