A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractCommandBuilder<TCmd,T extends AbstractCommandBuilder<TCmd,T>> - Class in com.tapkey.mobile.tlcp.commands
- AbstractCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.AbstractCommandBuilder
- AbstractPermanentUnlockTriggerLockCommandBuilder<TCmd extends net.tpky.mc.tlcp.model.AbstractPermanentUnlockTriggerLockCommand,T extends AbstractPermanentUnlockTriggerLockCommandBuilder<TCmd,T>> - Class in com.tapkey.mobile.tlcp.commands
- AbstractPermanentUnlockTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
- AbstractTriggerLockCommandBuilder<TCmd,T extends AbstractTriggerLockCommandBuilder<TCmd,T>> - Class in com.tapkey.mobile.tlcp.commands
- AbstractTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.AbstractTriggerLockCommandBuilder
- Action<TException extends Exception> - Interface in com.tapkey.mobile.utils
-
Encapsulates a method that has no parameters and does not return a value, but might throw an exception.
- Action1<TArg1,TException extends Exception> - Interface in com.tapkey.mobile.utils
-
Encapsulates a method that has a single parameter and does not return a value, but might throw an exception.
- Action2<TArg1,TArg2,TException extends Exception> - Interface in com.tapkey.mobile.utils
-
Encapsulates a method that has two parameters and does not return a value, but might throw an exception.
- addDataContextMigrationListener(DataContextMigrationListener) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Reserved for internal use.
- Added - com.tapkey.mobile.manager.KeyManager.KeyChangedType
- addObserver(Action1<T, ? extends RuntimeException>) - Method in interface com.tapkey.mobile.utils.Observable
-
Adds an observer to the set of observers for this object.
- addV1Format(Func<String, RuntimeException>) - Method in class com.tapkey.mobile.ble.TapkeyBleAdvertisingFormatBuilder
-
Adds support for Tapkey Advertising format version 1.
- addV1Format(String) - Method in class com.tapkey.mobile.ble.TapkeyBleAdvertisingFormatBuilder
-
Adds support for Tapkey Advertising format version 1.
- addV2Format(Func<Integer, RuntimeException>) - Method in class com.tapkey.mobile.ble.TapkeyBleAdvertisingFormatBuilder
-
Adds support for Tapkey Advertising format version 2.
- addV2Format(Integer) - Method in class com.tapkey.mobile.ble.TapkeyBleAdvertisingFormatBuilder
-
Adds support for Tapkey Advertising format version 2.
- allowIndefiniteUnlock - Variable in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
-
By default the lock will be locked after the validity of the users grant ends.
- allowPermanentUnlockCustomDuration - Variable in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
-
If set, the permanent unlock TriggerLock command may specify a custom unlock duration.
- allowTemporaryUnlockCustomDuration - Variable in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
-
Specifies, whether TriggerLock commands may specify a custom unlock duration for TemporaryUnlock actions.
- allowUnrestrictedTemporaryUnlockDuration - Variable in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
-
If set to true, the maximum custom unlock duration is only limited by the lock FW.
- any(CancellationToken...) - Static method in class com.tapkey.mobile.concurrent.CancellationTokens
-
Creates a cancellation token that goes into cancelled state if at least one of the specified tokens goes into cancelled state.
- asConst(TConvert) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Converts this
Promise
into one returning the specified value. - asVoid() - Method in interface com.tapkey.mobile.concurrent.Promise
- Async - Class in com.tapkey.mobile.concurrent
- AsyncCallback<T> - Interface in com.tapkey.mobile.concurrent
-
An async callback function.
- AsyncException - Exception in com.tapkey.mobile.concurrent
-
An AsyncException represents an exception that occurred during an asynchronous operation.
- AsyncException(Exception, AsyncStackTrace) - Constructor for exception com.tapkey.mobile.concurrent.AsyncException
-
Creates a new AsyncException that encapsulates the given exception and stores where and when it occurred.
- AsyncResponse - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The result is still pending.
- AsyncResult<T> - Interface in com.tapkey.mobile.concurrent
-
Represents the result of an asynchronous operation.
- AsyncResultFromException(Exception) - Static method in class com.tapkey.mobile.concurrent.Async
-
Creates an
AsyncResult
that resolves to the givenException
. - AsyncResultFromResult(T) - Static method in class com.tapkey.mobile.concurrent.Async
-
Creates an
AsyncResult
that resolves to the given result. - AsyncScheduler - Interface in com.tapkey.mobile.concurrent
-
An object used to execute given functionality at a given time.
- AuthenticationHandlerErrorCodes - Class in com.tapkey.mobile.auth
-
A collection of error codes related to authentication with the SDK.
- AuthenticationHandlerErrorCodes() - Constructor for class com.tapkey.mobile.auth.AuthenticationHandlerErrorCodes
- AutoTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building an auto trigger lock command.
- AutoTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.AutoTriggerLockCommandBuilder
B
- BindingError - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The binding of the key does not match the lock's binding.
- bindLockAsync(String, String, TlcpConnection, boolean, Integer, Action1<Float, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- bindLockLocalAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- BleLock - Class in com.tapkey.mobile.model
-
A nearby Tapkey lock discovered via Bluetooth.
- BleLock(byte[], String, String, Date, int) - Constructor for class com.tapkey.mobile.model.BleLock
- BleLockCommunicator - Interface in com.tapkey.mobile.ble
-
The BLE (Bluetooth Low Energy) lock communicator provides means to communicate with Tapkey locks via BLE.
- BleLockScanner - Interface in com.tapkey.mobile.ble
-
The BLE (Bluetooth Low Energy) lock scanner provides means to scan for Tapkey locks via BLE.
- BoundLock - Class in com.tapkey.mobile.model
-
A user's view of a locking device.
- BoundLock(String, String, LockType, String, String) - Constructor for class com.tapkey.mobile.model.BoundLock
- Break - com.tapkey.mobile.concurrent.LoopResult
-
The loop should stop after the current iteration.
- build() - Method in class com.tapkey.mobile.ble.TapkeyBleAdvertisingFormatBuilder
-
Builds and returns the
TapkeyBleAdvertisingFormat
instance. - build() - Method in class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder
-
Builds the TapkeyEnvironment configuration.
- build() - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Builds the service factory.
- build() - Method in class com.tapkey.mobile.tlcp.commands.AbstractCommandBuilder
- build() - Method in class com.tapkey.mobile.tlcp.commands.AutoTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.CompatTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.CustomTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.DefaultTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.PermanentLockTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.PermanentToggleTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.PermanentUnlockTriggerLockCommandBuilder
-
Builds the command.
- build() - Method in class com.tapkey.mobile.tlcp.commands.TemporaryTriggerUnlockCommandBuilder
-
Builds the command.
- buildCommand(Session, CryptArtifactsMetaData) - Method in interface com.tapkey.mobile.utils.DynamicCommand
C
- cancelable(CancellationToken, boolean) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Allows a promise chain being cancelled.
- CancellationToken - Interface in com.tapkey.mobile.concurrent
-
Objects that allow cancelling long running operations.
- CancellationTokenRegistration - Interface in com.tapkey.mobile.concurrent
-
A registration returned by
CancellationToken.register(Action, boolean)
. - CancellationTokens - Class in com.tapkey.mobile.concurrent
- CancellationTokens() - Constructor for class com.tapkey.mobile.concurrent.CancellationTokens
- CancellationTokenSource - Class in com.tapkey.mobile.concurrent
-
This class provides functionality to control the execution of promises.
- CancellationTokenSource() - Constructor for class com.tapkey.mobile.concurrent.CancellationTokenSource
-
Creates a new cancellation token source.
- CancellationTokenSource(boolean) - Constructor for class com.tapkey.mobile.concurrent.CancellationTokenSource
-
Creates a new cancellation token source with cancellation already requested.
- catchAsyncOnUi(Func1<AsyncException, Promise<T>, RuntimeException>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers an async function which is invoked on this instance's scheduler if this task completes exceptionally.
- catchOnUi(Func1<AsyncException, T, ? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers an
Action
which is invoked on this instance's scheduler if this task completes exceptionally. - changeAdminModeAsync(TlcpConnection, CryptArtifacts, TkLockMode, AdminModeOperationType, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- close() - Method in interface com.tapkey.mobile.concurrent.CancellationTokenRegistration
-
Cancels the registration to a
CancellationToken
. - close() - Method in interface com.tapkey.mobile.utils.ObserverRegistration
-
Unregisters the observer from the observable.
- closeAsync() - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- com.tapkey.mobile - package com.tapkey.mobile
- com.tapkey.mobile.auth - package com.tapkey.mobile.auth
- com.tapkey.mobile.ble - package com.tapkey.mobile.ble
- com.tapkey.mobile.broadcast - package com.tapkey.mobile.broadcast
- com.tapkey.mobile.concurrent - package com.tapkey.mobile.concurrent
- com.tapkey.mobile.error - package com.tapkey.mobile.error
- com.tapkey.mobile.manager - package com.tapkey.mobile.manager
- com.tapkey.mobile.model - package com.tapkey.mobile.model
- com.tapkey.mobile.pn - package com.tapkey.mobile.pn
- com.tapkey.mobile.tlcp - package com.tapkey.mobile.tlcp
- com.tapkey.mobile.tlcp.commands - package com.tapkey.mobile.tlcp.commands
- com.tapkey.mobile.utils - package com.tapkey.mobile.utils
- CommandExecutionFacade - Interface in com.tapkey.mobile.manager
-
Offers commands to be executed on Tapkey locks.
- CommandExecutionFacade.FirmwareUpgradeProgress - Interface in com.tapkey.mobile.manager
-
Returns information on a firmware upgrade progress.
- CommandResult - Class in com.tapkey.mobile.model
-
The result of a command, returned by a Tapkey lock.
- CommandResult(Date, ServerClockTime, CommandResult.CommandResultCode, Object, List<CommandResult.UserCommandResult>, PublicState) - Constructor for class com.tapkey.mobile.model.CommandResult
- CommandResult.CommandResultCode - Enum in com.tapkey.mobile.model
-
Represents a command's result code.
- CommandResult.UserCommandResult - Class in com.tapkey.mobile.model
-
The result of a user command.
- CommandResult.UserCommandResult.UserCommandResultCode - Enum in com.tapkey.mobile.model
-
Represents a user command's result code.
- CompatTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a trigger lock command that chooses the action to be performed based on the user's permissions.
- CompatTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.CompatTriggerLockCommandBuilder
- conclude() - Method in interface com.tapkey.mobile.concurrent.Promise
-
Concludes an async flow.
- connectAsync(CancellationToken) - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- Continue - com.tapkey.mobile.concurrent.LoopResult
-
The loop should continue with the next iteration, if any.
- continueAsyncOnUi(Func1<? super T, Promise<TNext>, ? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers an async function which will be invoked on this instance's scheduler as soon as the underlying task completed successfully.
- continueAsyncOnUiWithAsyncResult(Func1<AsyncResult<? extends T>, Promise<TNext>, ? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers an async function which will be invoked on this instance's scheduler as soon as the underlying task completed successfully.
- continueOnUi(Func1<? super T, TNext, ? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers a function which will be invoked on this instance's scheduler as soon as the underlying task has completed successfully.
- continueOnUiWithAsyncResult(Func1<AsyncResult<? extends T>, TNext, ? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers a function which will be invoked on this instance's scheduler as soon as the underlying task is completed successfully.
- create(Gson, TypeToken<R>) - Method in class net.tpky.contrib.com.google.gson.typeadapter.RuntimeTypeAdapterFactory
- CryptArtifactsMetaData - Class in com.tapkey.mobile.model
-
Meta data of CryptArtifacts CryptArtifacts contain the cryptographic material for executing commands on locking devices.
- CryptArtifactsMetaData(String, String, String, GrantDto) - Constructor for class com.tapkey.mobile.model.CryptArtifactsMetaData
- CustomTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a custom trigger lock command.
- CustomTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.CustomTriggerLockCommandBuilder
D
- deactivateAdminModeAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- DEBUG - Static variable in class com.tapkey.mobile.utils.Logs
-
Priority constant for the println method; use Log.d.
- DEFAULT_INTERVAL - Static variable in class com.tapkey.mobile.broadcast.PollingScheduler
-
The default polling interval of eight hours.
- DefaultTriggerLock - com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Default trigger lock action, specified by the firmware
- DefaultTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a default trigger lock command.
- DefaultTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.DefaultTriggerLockCommandBuilder
- defaultUnlockDurationSec - Variable in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
-
The default unlock duration for temporary unlock operations in seconds.
- delayAsync(long) - Static method in class com.tapkey.mobile.concurrent.Async
-
Returns a
Promise
that completes after the given time span. - delayAsync(long, CancellationToken) - Static method in class com.tapkey.mobile.concurrent.Async
-
Returns a
Promise
that completes after either the given time span elapsed or the givenCancellationToken
requested cancellation. - downloadFirmwareContentAsync(String, String, String, CancellationToken) - Method in interface com.tapkey.mobile.manager.FirmwareManager
- DynamicCommand - Interface in com.tapkey.mobile.utils
E
- equals(Object) - Method in class com.tapkey.mobile.model.BleLock
- equals(Object) - Method in class com.tapkey.mobile.model.PermissionDetails
- equals(Object) - Method in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- equals(Object) - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- ERROR - Static variable in class com.tapkey.mobile.utils.Logs
-
Priority constant for the println method; use Log.e.
- executeAsync(Func<T, ? extends Exception>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Runs the specified operation on a multi-threaded worker-thread-backed scheduler.
- executeCommandAsync(String, String, Func1<TlcpConnection, Promise<TOut>, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.ble.BleLockCommunicator
-
Executes a command on the specified lock.
- executeCustomCommandAsync(TlcpConnection, boolean, int, int, byte[], CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- executeCustomCommandSignedAsync(TlcpConnection, int, int, byte[], CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- executeCustomCommandSimpleAsync(TlcpConnection, boolean, int, int, byte[], CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- executeOnScheduler(AsyncScheduler, Func<T, ? extends Exception>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Executes the specified function on the specified scheduler and returns a promise which will deliver the result on the caller's current
AsyncScheduler
. - executeStandardCommandAsync(TlcpConnection, DynamicCommand, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Executes a dynamic standard command.
- executeStandardCommandAsync(TlcpConnection, Command, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Executes a standard command like a TriggerLockCommand.
F
- finallyAsyncOnUi(Func<Promise<Void>, ? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers an async function which will be invoked on this instance's scheduler as soon as the underlying task is completed, regardless of whether it completes successfully or exceptionally.
- finallyOnUi(Action<? extends Exception>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers an
Action
which is invoked on this instance's scheduler as soon as the underlying task is completed, regardless of whether it completes successfully or exceptionally. - FirmwareContent() - Constructor for class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- FirmwareInfo() - Constructor for class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- FirmwareManager - Interface in com.tapkey.mobile.manager
-
Reserved for internal use.
- FirmwarePackage - Class in com.tapkey.mobile.model
-
Reserved for internal use.
- FirmwarePackage() - Constructor for class com.tapkey.mobile.model.FirmwarePackage
- FirmwarePackage(FirmwarePackage.FirmwareInfo, FirmwarePackage.FirmwareContent) - Constructor for class com.tapkey.mobile.model.FirmwarePackage
- FirmwarePackage.FirmwareContent - Class in com.tapkey.mobile.model
- FirmwarePackage.FirmwareInfo - Class in com.tapkey.mobile.model
- first() - Static method in class com.tapkey.mobile.concurrent.Async
-
Returns a completed
Promise
that resolves to null. - first(Action<? extends Exception>) - Static method in class com.tapkey.mobile.concurrent.Async
- first(Func<T, ? extends Exception>) - Static method in class com.tapkey.mobile.concurrent.Async
- firstAsync(Func<Promise<T>, RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
- firstWithAsyncStackTraceEnabled(boolean) - Static method in class com.tapkey.mobile.concurrent.Async
-
for internal use
- forAsync(int, Func1<Integer, Promise<LoopResult>, ? extends RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Counts from 0 to n (excluding) and sequentially executes the given async functions for each value.
- foreachAsync(Iterable<? extends T>, Func1<T, Promise<LoopResult>, ? extends RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Iterates the given items and sequentially executes the given async functions for each item.
- foreachResAsync(Iterable<? extends TIn>, Func1<TIn, Promise<TOut>, ? extends RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Iterates the given items and sequentially executes the given async functions for each item.
- fromTimeout(int) - Static method in class com.tapkey.mobile.concurrent.CancellationTokens
-
Creates a cancellation token that goes into cancelled state after the specified timeout period elapsed.
- Func<TRes,TException extends Exception> - Interface in com.tapkey.mobile.utils
-
Encapsulates a method that has no parameters and returns a value of the type specified by the TRes parameter.
- Func1<T1,TRes,TException extends Exception> - Interface in com.tapkey.mobile.utils
-
Encapsulates a method that has a single parameter and returns a value of the type specified by the TRes parameter.
- Func2<T1,T2,TRes,TException extends Exception> - Interface in com.tapkey.mobile.utils
-
Encapsulates a method that has two parameters and returns a value of the type specified by the TRes parameter.
G
- get() - Method in interface com.tapkey.mobile.concurrent.AsyncResult
-
Returns the result of the asynchronous operation.
- getAdminModeType() - Method in class com.tapkey.mobile.model.LockState
- getAdvertisingParser() - Method in interface com.tapkey.mobile.ble.TapkeyBleAdvertisingFormat
-
Gets an advertising parser.
- getAllowedActionTypes() - Method in class com.tapkey.mobile.model.PermissionDetails
- getAllowIndefiniteUnlock() - Method in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- getAllowPermanentUnlockCustomDuration() - Method in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- getAllowTemporaryUnlockCustomDuration() - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- getAllowUnrestrictedTemporaryUnlockDuration() - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- getAndroidScanFilter(ScanFilter) - Static method in class com.tapkey.mobile.ble.ScanFilters
- getAutoRenewalScheduledAt() - Method in class com.tapkey.mobile.model.KeyDetails
-
Returns at what point this mobile key is scheduled to be automatically renewed.
- getAutorenewedBefore() - Method in class com.tapkey.mobile.model.KeyDetails
-
Returns the latest point in time until when the key should get renewed.
- getBaseUri() - Method in interface com.tapkey.mobile.TapkeyEndpointConfig
-
Returns the base URI of the Tapkey Trust Service.
- getBatteryWarningLevel() - Method in class com.tapkey.mobile.model.LockState
- getBatteryWarnLevel() - Method in class com.tapkey.mobile.model.CommandResult
-
Returns the lock's battery warning level.
- getBleLockCommunicator() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the BLE (Bluetooth Low Energy) lock communicator that is used to communicate with Tapkey locks via Bluetooth.
- getBleLockScanner() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the BLE (Bluetooth Low Energy) lock scanner that is used to scan for Tapkey locks via Bluetooth.
- getBluetoothAddress() - Method in class com.tapkey.mobile.model.BleLock
-
Returns the lock's Bluetooth address.
- getBoundLock() - Method in class com.tapkey.mobile.model.UserGrant
-
The locking device the grant relates to.
- getBoundLockId() - Method in class com.tapkey.mobile.model.BoundLock
-
Returns the Id of the BoundLock.
- getBuildString() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getBuildString() - Method in class com.tapkey.mobile.model.LockState
- getCallerData() - Method in class com.tapkey.mobile.tlcp.commands.AbstractCommandBuilder
- getCallerStackTrace() - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
for internal use
- getCentralToPeripheralCharacteristicUuid() - Method in class com.tapkey.mobile.ble.TapkeyBleGattServiceConfig
-
The GATT characteristic UUID used for sending frames from the central device to the peripheral.
- getChangedType() - Method in class com.tapkey.mobile.manager.KeyManager.KeyChangedEvent
- getChunkSize() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- getClientRef() - Method in class com.tapkey.mobile.model.BoundLock
-
An optional reference specified by the client application.
- getCommandExecutionFacade() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the command execution facade that is used to build execute commands on Tapkey locks.
- getCommandResultCode() - Method in class com.tapkey.mobile.model.CommandResult
-
Returns the result code of this command.
- getCompatibleFromVersion() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getContent() - Method in class com.tapkey.mobile.model.FirmwarePackage
- getCustomCommandData() - Method in class com.tapkey.mobile.tlcp.commands.AbstractTriggerLockCommandBuilder
- getCustomCommandDescriptorsAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- getDefaultUnlockDurationSec() - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- getDeviceSerialNo() - Method in class com.tapkey.mobile.model.LockState
- getDiagnosticsHandler() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
for internal use
- getDurationSec() - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
- getEnvironmentInfos() - Method in interface com.tapkey.mobile.manager.SupportManager
-
Returns information about the current environment for debugging purposes.
- getErrorCode() - Method in exception com.tapkey.mobile.error.TkException
-
Returns the exception's error code.
- getErrorCode() - Method in class com.tapkey.mobile.model.SyncLockCommandResult
-
Returns the command's result code.
- getErrorCode() - Method in class com.tapkey.mobile.model.TkErrorDescriptor
-
Returns the error code.
- getErrorDetails() - Method in class com.tapkey.mobile.model.TkErrorDescriptor
-
Returns the error details.
- getErrorMessage() - Method in class com.tapkey.mobile.model.TkErrorDescriptor
-
Returns the error message.
- getFileDescriptor() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- getFirmwareData() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- getFirmwareInfoId() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- getFirmwareManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the firmware manager that is used to retrieve firmware updates for Tapkey locks.
- getFirmwareVersionInt() - Method in class com.tapkey.mobile.model.LockState
- getFwType() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getFwType() - Method in class com.tapkey.mobile.model.LockState
- getGrant() - Method in class com.tapkey.mobile.model.CryptArtifactsMetaData
-
Returns details about the Grant related to this instance.
- getGrant() - Method in class com.tapkey.mobile.model.KeyDetails
-
Returns the grant this mobile key has been issued for.
- getGrantId() - Method in class com.tapkey.mobile.manager.KeyManager.KeyChangedEvent
- getGrantId() - Method in class com.tapkey.mobile.model.KeyDetails
-
Returns the corresponding grant's ID.
- getGroupInfos() - Method in class com.tapkey.mobile.model.GroupInfos
- getGroupInfos() - Method in class com.tapkey.mobile.model.LockState
- getHttpAuthenticationProvider() - Method in interface com.tapkey.mobile.manager.UserManager
-
Reserved for internal use.
- getId() - Method in class com.tapkey.mobile.model.GroupInfo
- getId() - Method in class com.tapkey.mobile.model.LockType
-
The Tapkey-assigned ID.
- getId() - Method in class com.tapkey.mobile.model.Owner
- getId() - Method in class com.tapkey.mobile.model.UserGrant
-
This Grant's ID.
- getInfo() - Method in class com.tapkey.mobile.model.FirmwarePackage
- getKey() - Method in class com.tapkey.mobile.utils.KeyValuePair
-
Retrieves the key of the KeyValuePair
- getKeyManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the key manager that is used to handle keys issued by the Tapkey Trust Service for this device.
- getKeyUpdateObservable() - Method in interface com.tapkey.mobile.manager.KeyManager
-
Returns an observable that can be used to receive notifications whenever mobile keys on this device are updated.
- getLastSeen() - Method in class com.tapkey.mobile.model.BleLock
-
Returns at what time the lock was last seen nearby.
- getLocalKeys(String) - Method in interface com.tapkey.mobile.manager.KeyManager
-
Returns all mobile keys available for the specified user on this device.
- getLock(byte[]) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Deprecated.Use
BleLockScanner.getLock(String)
instead. - getLock(String) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Returns the BLE lock representation of the lock with the specified lock ID.
- getLockId() - Method in class com.tapkey.mobile.ble.TapkeyAdvertisingData
-
The Tapkey Lock ID.
- getLockId() - Method in class com.tapkey.mobile.manager.KeyManager.KeyChangedEvent
- getLockId() - Method in class com.tapkey.mobile.model.BleLock
-
Deprecated.Use the Base64-encoded representation returned by
BleLock.getPhysicalLockId()
instead. - getLockId() - Method in class com.tapkey.mobile.model.CryptArtifactsMetaData
-
Returns the boundLockId the CryptArtifacts are issued for
- getLockId() - Method in class com.tapkey.mobile.model.LockState
- getLockIdHex() - Method in class com.tapkey.mobile.model.LockState
- getLocks() - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Returns a list of nearby locks along with their Bluetooth address.
- getLocks(byte[]) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Deprecated.Use
BleLockScanner.getLocks(String)
instead. - getLocks(String) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Returns a list of BLE locks advertising the specified lock id.
- getLocksChangedObservable() - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Returns an Observable of a list of nearby locks along with their Bluetooth address.
- getLockTime() - Method in class com.tapkey.mobile.model.CommandResult
-
Returns the time on the lock when the command was executed.
- getLockTime() - Method in class com.tapkey.mobile.model.LockState
- getLockType() - Method in class com.tapkey.mobile.model.BoundLock
-
The LockType of the PhysicalLock.
- getLogger() - Static method in class com.tapkey.mobile.utils.Logs
- getManufactureId() - Method in class com.tapkey.mobile.model.LockState
- getManufacturerId() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getManufacturerId() - Method in class com.tapkey.mobile.model.LockType
-
The Id of the lock manufacturer as reported by locks of this type.
- getMaxCustomUnlockDurationSec() - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- getMaxSize() - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- getMembershipSequenceNo() - Method in class com.tapkey.mobile.model.GroupInfo
- getMessage() - Method in interface com.tapkey.mobile.concurrent.CancellationToken
-
Returns the cancellation message if any.
- getMessage() - Method in exception com.tapkey.mobile.error.TkException
-
Returns the exception's error message.
- getModelName() - Method in class com.tapkey.mobile.model.LockState
- getModelName() - Method in class com.tapkey.mobile.model.LockType
-
The lock's model name.
- getName() - Method in class com.tapkey.mobile.model.Owner
- getNofChunksCompleted() - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade.FirmwareUpgradeProgress
-
Returns the number of chunks of the given firmware package that have been uploaded to the lock.
- getNotificationManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the notification manager that is used for polling information from the Tapkey Trust Service.
- getOwner() - Method in class com.tapkey.mobile.model.UserGrant
-
The owner account, the grant belongs to.
- getPeripheralToCentralCharacteristicUuid() - Method in class com.tapkey.mobile.ble.TapkeyBleGattServiceConfig
-
The GATT characteristic UUID used by the peripheral for notifying the central device about characteristic changes.
- getPermanentUnlockDetails() - Method in class com.tapkey.mobile.model.PermissionDetails
- getPermissionDetails() - Method in class com.tapkey.mobile.model.UserGrant
-
Details about the actions the client is allowed to perform.
- getPhysicalLockId() - Method in class com.tapkey.mobile.model.BleLock
-
The Base64-encoded TLCP lock ID.
- getPhysicalLockId() - Method in class com.tapkey.mobile.model.BoundLock
-
Returns the Id of the PhysicalLock which the BoundLock is bound to.
- getProgress() - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade.FirmwareUpgradeProgress
-
The overall progress of the firmware upgrade.
- getPromise() - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Returns the
Promise
associated with this instance. - getProtocolVersionInt() - Method in class com.tapkey.mobile.model.LockState
- getProtocolVersionStr() - Method in class com.tapkey.mobile.model.LockState
- getPublicState() - Method in class com.tapkey.mobile.model.PublicStateInfo
-
Returns the lock's public state.
- getPushNotificationManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the push notification manager that is used for handling incoming push notifications or null if no PushNotificationTokenProvider has been set.
- getQueriedAt() - Method in class com.tapkey.mobile.model.PublicStateInfo
-
Returns the server clock time when the lock's public state was retrieved.
- getRclSerialNo() - Method in class com.tapkey.mobile.model.GroupInfo
- getRclVersion() - Method in class com.tapkey.mobile.model.LockState
- getReleaseDate() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getReleaseLevel() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getReleaseNotes() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getRenewableFrom() - Method in class com.tapkey.mobile.model.KeyDetails
-
Returns from which point in time this mobile key can be renewed.
- getResponseData() - Method in class com.tapkey.mobile.model.CommandResult
-
Reserved for internal use.
- getResponseData() - Method in class com.tapkey.mobile.model.CommandResult.UserCommandResult
-
Returns the response data of the user command.
- getResult() - Method in interface com.tapkey.mobile.concurrent.Promise
-
Returns the promised async result if this promise is completed.
- getResult() - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Returns the result this instance has been set to or null, if not in completed state yet.
- getRssi() - Method in class com.tapkey.mobile.model.BleLock
-
Returns the RSSI of the lock when it was last seen.
- getScanFilters() - Method in interface com.tapkey.mobile.ble.TapkeyBleAdvertisingFormat
-
Gets specifications of scan filters as they should be applied when searching for Tapkey-specific advertising data.
- getServerTime() - Method in class com.tapkey.mobile.model.CommandResult
-
Returns the time on the Tapkey Trust Service when the command was executed.
- getServiceConfigs() - Method in interface com.tapkey.mobile.ble.TapkeyBleGattServiceConfigProvider
-
Gets the Tapkey-specific service configuration.
- getServiceDataServiceUuid() - Method in class com.tapkey.mobile.ble.ScanFilter
-
The service UUID to filter for in the service data advertising data type.
- getServiceUuid() - Method in class com.tapkey.mobile.ble.ScanFilter
-
The service UUID to filter for.
- getServiceUuid() - Method in class com.tapkey.mobile.ble.TapkeyBleGattServiceConfig
-
The GATT service UUID.
- getSession() - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- getSupportedTechnologies() - Method in class com.tapkey.mobile.model.LockType
-
A list of supported communication technologies that can be used by end users to control the locking device.
- getSupportManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
for internal use
- getSyncSrcException() - Method in exception com.tapkey.mobile.concurrent.AsyncException
-
Returns the source exception.
- getTapkeyServiceFactory() - Method in interface com.tapkey.mobile.TapkeyAppContext
-
Returns the singleton instance of
TapkeyServiceFactory
. - getTemperature() - Method in class com.tapkey.mobile.model.LockState
- getTemporaryUnlockDetails() - Method in class com.tapkey.mobile.model.PermissionDetails
- getTenantId() - Method in interface com.tapkey.mobile.TapkeyEndpointConfig
-
Returns the Tapkey Trust Service tenant to use.
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.AbstractCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.AutoTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.CompatTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.CustomTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.DefaultTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.PermanentLockTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.PermanentToggleTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.PermanentUnlockTriggerLockCommandBuilder
- getThis() - Method in class com.tapkey.mobile.tlcp.commands.TemporaryTriggerUnlockCommandBuilder
- getTimeRestrictionIcal() - Method in class com.tapkey.mobile.model.UserGrant
-
An RFC 5545 (iCalendar) compliant string, describing the time restriction that applies to this grant.
- getTimeSpan() - Method in class com.tapkey.mobile.model.LockState
- getTitle() - Method in class com.tapkey.mobile.model.BoundLock
-
This lock's title as specified by the owner.
- getTkErrorDescriptor() - Method in exception com.tapkey.mobile.error.TkException
-
Returns the exception's inner error descriptor.
- getTlcpMessageConnection() - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- getToken() - Method in class com.tapkey.mobile.concurrent.CancellationTokenSource
-
Returns the
CancellationToken
associated with this instance. - getTransportChannel() - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- getUnlockDurationSec() - Method in class com.tapkey.mobile.tlcp.commands.TemporaryTriggerUnlockCommandBuilder
- getUntilUtc() - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
- getUntilUtcTkDateTime() - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
- getUserCommandResultCode() - Method in class com.tapkey.mobile.model.CommandResult.UserCommandResult
-
Returns the result code of the user command.
- getUserCommandResults() - Method in class com.tapkey.mobile.model.CommandResult
-
Reserved for internal use.
- getUserId() - Method in class com.tapkey.mobile.manager.KeyManager.KeyChangedEvent
- getUserId() - Method in class com.tapkey.mobile.model.CommandResult.UserCommandResult
-
Returns the ID of the user who executed the command.
- getUserManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory
-
Returns the user manager that can be used to log in users, retrieve all users currently logged in and log out users.
- getUsers() - Method in interface com.tapkey.mobile.manager.UserManager
-
Returns IDs of the users who are currently logged in.
- getValidBefore() - Method in class com.tapkey.mobile.model.CryptArtifactsMetaData
-
Returns the time when the CryptArtifacts expire.
- getValidBefore() - Method in class com.tapkey.mobile.model.KeyDetails
-
Returns until when this mobile key is valid.
- getValidBefore() - Method in class com.tapkey.mobile.model.UserGrant
-
Date when the access permission expires.
- getValidFrom() - Method in class com.tapkey.mobile.model.CryptArtifactsMetaData
-
Returns the time from when the CryptArtifacts are valid from.
- getValidFrom() - Method in class com.tapkey.mobile.model.UserGrant
-
Date from when on access is granted.
- getValue() - Method in class com.tapkey.mobile.utils.KeyValuePair
-
Retrieves the value of the KeyValuePair
- getValue1() - Method in class com.tapkey.mobile.utils.Tuple
-
Retrieves the first value of the Tuple.
- getValue2() - Method in class com.tapkey.mobile.utils.Tuple
-
Retrieves the second value of the Tuple.
- getVersionCode() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getVersionName() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- getVoltage() - Method in class com.tapkey.mobile.model.LockState
- GroupInfo - Class in com.tapkey.mobile.model
- GroupInfo(byte[], Long, Integer) - Constructor for class com.tapkey.mobile.model.GroupInfo
- groupInfos - Variable in class com.tapkey.mobile.model.GroupInfos
- GroupInfos - Class in com.tapkey.mobile.model
- GroupInfos(GroupInfo[]) - Constructor for class com.tapkey.mobile.model.GroupInfos
H
- hasActivationStarted() - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade.FirmwareUpgradeProgress
-
Returns whether the activation phase of the firmware upgrade has started and the lock is rebooting into the newly installed firmware.
- hashCode() - Method in class com.tapkey.mobile.model.BleLock
- hashCode() - Method in class com.tapkey.mobile.model.PermissionDetails
- hashCode() - Method in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- hashCode() - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
I
- INFO - Static variable in class com.tapkey.mobile.utils.Logs
-
Priority constant for the println method; use Log.i.
- invoke() - Method in interface com.tapkey.mobile.utils.Action
-
Invokes the action.
- invoke() - Method in interface com.tapkey.mobile.utils.Func
-
Invokes the method with the given parameter.
- invoke(T1) - Method in interface com.tapkey.mobile.utils.Func1
-
Invokes the method with the given parameter.
- invoke(T1, T2) - Method in interface com.tapkey.mobile.utils.Func2
-
Invokes the method with the given parameters.
- invoke(TArg1) - Method in interface com.tapkey.mobile.utils.Action1
-
Invokes the action with the given parameter.
- invoke(TArg1, TArg2) - Method in interface com.tapkey.mobile.utils.Action2
-
Invokes the action with the given parameters.
- isAllowDurationReduction() - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
- isBound() - Method in class com.tapkey.mobile.model.CommandResult
-
Returns whether the lock is bound or not.
- isBound() - Method in class com.tapkey.mobile.model.LockState
- isCancellationRequested() - Method in interface com.tapkey.mobile.concurrent.CancellationToken
-
Returns whether cancellation has been requested.
- isCompleted() - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Returns whether this instance and the returned
Promise
are in completed state, regardless of whether completed successfully or exceptionally. - isInCurrentContext() - Method in interface com.tapkey.mobile.concurrent.AsyncScheduler
- isLockNearby(byte[]) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Deprecated.Use
BleLockScanner.isLockNearby(String)
instead. - isLockNearby(byte[], int) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Deprecated.Use
BleLockScanner.isLockNearby(String, int)
instead. - isLockNearby(String) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Returns whether the Tapkey lock with the specified physical lock ID is nearby.
- isLockNearby(String, int) - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Same as
BleLockScanner.isLockNearby(String)
, but with configurable RSSI threshold. - isLogsWaiting() - Method in class com.tapkey.mobile.model.LockState
- isTimeComparedToServer() - Method in class com.tapkey.mobile.model.LockState
- isTimeSpanOutOfBound() - Method in class com.tapkey.mobile.model.LockState
J
- Jammed - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Mechanical error on the lock
- Jammed - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
Mechanical error on the lock
K
- KeyChangedEvent(KeyManager.KeyChangedType, String, String, String) - Constructor for class com.tapkey.mobile.manager.KeyManager.KeyChangedEvent
- KeyDetails - Class in com.tapkey.mobile.model
-
A set of information on a locally available mobile key.
- KeyDetails(String, UserGrant, Date, Date, Date, Date) - Constructor for class com.tapkey.mobile.model.KeyDetails
- KeyManager - Interface in com.tapkey.mobile.manager
-
The key manager provides access to the available mobile keys on this device.
- KeyManager.KeyChangedEvent - Class in com.tapkey.mobile.manager
- KeyManager.KeyChangedType - Enum in com.tapkey.mobile.manager
- KeyValuePair<TKey,TValue> - Class in com.tapkey.mobile.utils
-
Provides a structure of a key and a corresponding value.
- KeyValuePair(TKey, TValue) - Constructor for class com.tapkey.mobile.utils.KeyValuePair
-
Construct a KeyValuePair with the given key and the corresponding value.
L
- LockCommunicationError - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
A transport-level error occurred when communicating with the locking device, e.g.
- LockCommunicationError - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
An error occurred while communicating with the locking device.
- LockDateTimeInvalid - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Lock date/time are invalid.
- LockDateTimeInvalid - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
Lock date/time are invalid.
- LockNotFullyAssembled - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The lock is not fully assembled.
- LockNotFullyAssembled - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The lock is not fully assembled.
- LockState - Class in com.tapkey.mobile.model
-
Reserved for internal use.
- LockState(byte[], String, int, String, int, Long, GroupInfo[], Date, Long, boolean, Double, Double, Double, String, String, String, boolean, boolean, Integer, String, int, boolean) - Constructor for class com.tapkey.mobile.model.LockState
- LockType - Class in com.tapkey.mobile.model
-
The description of a lock type.
- LockType() - Constructor for class com.tapkey.mobile.model.LockType
- LockVersionTooOld - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The lock is not supported anymore by this version of the SDK.
- LockVersionTooYoung - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The lock's firmware is not yet supported by this version of the SDK.
- Logger - Interface in com.tapkey.mobile.utils
-
Provides an interface to a Logger object that is used to log messages.
- logInAsync(String, CancellationToken) - Method in interface com.tapkey.mobile.manager.UserManager
-
Logs in a user with a Tapkey access token.
- logOutAsync(String, CancellationToken) - Method in interface com.tapkey.mobile.manager.UserManager
-
Logs out a user with a Tapkey access token.
- Logs - Class in com.tapkey.mobile.utils
- Logs() - Constructor for class com.tapkey.mobile.utils.Logs
- loopAsync(Func<Promise<LoopResult>, RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Executes the given async function until one of the following happens: * the
Promise
returned by the async function resolved to something other thanLoopResult.Continue
or null (i.e. - LoopResult - Enum in com.tapkey.mobile.concurrent
-
The outcome of a single iteration of a control loop.
M
- maxCustomUnlockDurationSec - Variable in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
-
The maximum unlock duration for temporary unlock operations in seconds.
N
- net.tpky.contrib.com.google.gson.typeadapter - package net.tpky.contrib.com.google.gson.typeadapter
- None - Static variable in class com.tapkey.mobile.concurrent.CancellationTokens
-
A cancellation token that will never be cancelled.
- NothingToDo - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The command was successfully received, but not executed.
- NothingToDo - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The command was successfully received, but not executed.
- NotificationManager - Interface in com.tapkey.mobile.manager
-
Provides methods to poll for updates from the Tapkey Trust Service.
- NotLicensed - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The lock has no active license
- NotLicensed - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The lock has no active license
O
- Observable<T> - Interface in com.tapkey.mobile.utils
-
Represents an observable object with a given type.
- ObserverRegistration - Interface in com.tapkey.mobile.utils
-
An object that represents the registration on an Observable.
- of(Class<T>) - Static method in class net.tpky.contrib.com.google.gson.typeadapter.RuntimeTypeAdapterFactory
-
Creates a new runtime type adapter for
baseType
using"type"
as the type field name. - of(Class<T>, String) - Static method in class net.tpky.contrib.com.google.gson.typeadapter.RuntimeTypeAdapterFactory
-
Creates a new runtime type adapter using for
baseType
usingtypeFieldName
as the type field name. - of(Class<T>, String, boolean) - Static method in class net.tpky.contrib.com.google.gson.typeadapter.RuntimeTypeAdapterFactory
-
Creates a new runtime type adapter using for
baseType
usingtypeFieldName
as the type field name. - Ok - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Command executed successfully as requested.
- Ok - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
Command executed as requested.
- onReceive(Context, Intent) - Method in class com.tapkey.mobile.broadcast.PollingScheduler
- onRefreshFailed(String) - Method in interface com.tapkey.mobile.auth.TokenRefreshHandler
-
Will be called in case reauthentication of an access token has failed in a non-recoverable way.
- onResult(AsyncResult<? extends T>) - Method in interface com.tapkey.mobile.concurrent.AsyncCallback
-
An async callback function.
- Owner - Class in com.tapkey.mobile.model
- Owner() - Constructor for class com.tapkey.mobile.model.Owner
- Owner(String, String) - Constructor for class com.tapkey.mobile.model.Owner
P
- parseAdvertisingData(byte[]) - Method in interface com.tapkey.mobile.ble.TapkeyBleAdvertisingParser
-
Parses the specified advertising data.
- PermanentLock - com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Lock the lock until the lock will be unlocked with unlocking trigger action.
- PermanentLockTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a permanent lock command.
- PermanentLockTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.PermanentLockTriggerLockCommandBuilder
- PermanentToggle - com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Permanent toggle the state of the lock.
- PermanentToggleTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a permanent toggle command.
- PermanentToggleTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.PermanentToggleTriggerLockCommandBuilder
- PermanentUnlock - com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Unlock the lock and keep it open.
- PermanentUnlockPermissionDetails() - Constructor for class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- PermanentUnlockTriggerLockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a permanent unlock command.
- PermanentUnlockTriggerLockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.PermanentUnlockTriggerLockCommandBuilder
- PermissionDetails - Class in com.tapkey.mobile.model
- PermissionDetails() - Constructor for class com.tapkey.mobile.model.PermissionDetails
- PermissionDetails.PermanentUnlockPermissionDetails - Class in com.tapkey.mobile.model
- PermissionDetails.TemporaryUnlockPermissionDetails - Class in com.tapkey.mobile.model
- PermissionDetails.TriggerLockActionTypes - Enum in com.tapkey.mobile.model
- pollForNotificationsAsync(CancellationToken) - Method in interface com.tapkey.mobile.manager.NotificationManager
-
Polls for updates from the Tapkey Trust Service.
- PollingScheduler - Class in com.tapkey.mobile.broadcast
-
Schedules polling for updates from the Tapkey Trust Service.
- PollingScheduler() - Constructor for class com.tapkey.mobile.broadcast.PollingScheduler
- post(Runnable) - Method in interface com.tapkey.mobile.concurrent.AsyncScheduler
- postDelayed(Runnable, long) - Method in interface com.tapkey.mobile.concurrent.AsyncScheduler
- println(int, String, String, Throwable) - Method in interface com.tapkey.mobile.utils.Logger
-
Prints a log message in a separate line.
- printStackTrace(PrintStream) - Method in exception com.tapkey.mobile.concurrent.AsyncException
-
Prints the exception's stack trace on the given stream.
- printStackTrace(PrintWriter) - Method in exception com.tapkey.mobile.concurrent.AsyncException
-
Prints the exception's stack trace using the given print writer.
- processHelloMessage(byte[]) - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- Promise<T> - Interface in com.tapkey.mobile.concurrent
-
Implementation of the promise pattern, used for composing async program flows.
- PromiseFromAsyncResult(AsyncResult<? extends T>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Creates a completed promise that resolves to the given
AsyncResult
. - PromiseFromException(Exception) - Static method in class com.tapkey.mobile.concurrent.Async
-
Creates a failed promise, that resolves to the given exception.
- PromiseFromResult(T) - Static method in class com.tapkey.mobile.concurrent.Async
-
Creates a completed promise that resolves to the given value.
- PromiseSource<T> - Class in com.tapkey.mobile.concurrent
-
Instances of this class are used to create and complete
Promise
instances. - PromiseSource() - Constructor for class com.tapkey.mobile.concurrent.PromiseSource
-
Creates an instance based on the current schedule as returned by AsyncSchedulers#current().
- PromiseSource(AsyncScheduler) - Constructor for class com.tapkey.mobile.concurrent.PromiseSource
-
Creates an instance based on the given scheduler.
- PublicStateInfo - Class in com.tapkey.mobile.model
-
This class represents a lock's public state at a certain time.
- PublicStateInfo(PublicState, ServerClockTime) - Constructor for class com.tapkey.mobile.model.PublicStateInfo
- PushNotificationManager - Interface in com.tapkey.mobile.manager
-
The PushNotificationManager takes care of incoming push notifications and updated registration tokens.
- PushNotificationTokenProvider - Interface in com.tapkey.mobile.pn
-
Provider for tokens that can be used for sending push notifications to this app.
Q
- queryGroupInfosAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- queryPublicStateAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Returns the public state of the lock.
R
- ReauthenticationRequired - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The authentication information isn't valid anymore.
- receivedPushNotification(Map<String, String>) - Method in interface com.tapkey.mobile.manager.PushNotificationManager
-
To be called, when a Tapkey push notification was received by the push notification provider.
- refreshAuthenticationAsync(String, CancellationToken) - Method in interface com.tapkey.mobile.auth.TokenRefreshHandler
-
Will be called by the SDK whenever the Tapkey access token of the given user needs to be refreshed.
- register(Context, int, int) - Static method in class com.tapkey.mobile.broadcast.PollingScheduler
-
Registers polling for Tapkey notifications.
- register(AsyncCallback<? super T>) - Method in interface com.tapkey.mobile.concurrent.Promise
-
Registers a callback which will be invoked on this instance's scheduler with an
AsyncResult
, as soon as the underlying task is completed. - register(Action<? extends RuntimeException>) - Method in interface com.tapkey.mobile.concurrent.CancellationToken
-
Registers a function that is invoked when cancellation is requested.
- register(Action<? extends RuntimeException>, boolean) - Method in interface com.tapkey.mobile.concurrent.CancellationToken
-
Registers a function that is invoked when cancellation is requested.
- registerForPushNotificationsAsync() - Method in interface com.tapkey.mobile.pn.PushNotificationTokenProvider
-
Register for push notifications and returns a registration token which can be used to send messages to this client.
- registerSubtype(Class<? extends T>) - Method in class net.tpky.contrib.com.google.gson.typeadapter.RuntimeTypeAdapterFactory
-
Registers
type
identified by itssimple name
. - registerSubtype(Class<? extends T>, String) - Method in class net.tpky.contrib.com.google.gson.typeadapter.RuntimeTypeAdapterFactory
-
Registers
type
identified bylabel
. - Removed - com.tapkey.mobile.manager.KeyManager.KeyChangedType
- requestCancellation() - Method in class com.tapkey.mobile.concurrent.CancellationTokenSource
-
Requests cancellation of the affected promises.
- requestCancellation(String) - Method in class com.tapkey.mobile.concurrent.CancellationTokenSource
-
Requests cancellation of the affected promises and allows specifying a custom message.
- RuntimeTypeAdapterFactory<T> - Class in net.tpky.contrib.com.google.gson.typeadapter
-
Adapts values whose runtime type may differ from their declaration type.
S
- ScanFilter - Class in com.tapkey.mobile.ble
-
Data to be used to filter Bluetooth LE Advertising data before forwarding the results to the application layer.
- ScanFilter(String, String) - Constructor for class com.tapkey.mobile.ble.ScanFilter
- ScanFilters - Class in com.tapkey.mobile.ble
- ScanFilters() - Constructor for class com.tapkey.mobile.ble.ScanFilters
- ServerCommunicationError - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
An error occurred while trying to communicate with the Tapkey Trust Service (e.g.
- ServerCommunicationError - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
A technical error occurred when trying to communicate with the Tapkey Trust Service.
- setAllowDurationReduction(boolean) - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
-
Specifies, whether the locking device is allowed to reduce the requested unlock duration or until date if the specified value isn't in line with the permission granted to the user.
- setAllowedActionTypes(List<PermissionDetails.TriggerLockActionTypes>) - Method in class com.tapkey.mobile.model.PermissionDetails
- setAllowIndefiniteUnlock(Boolean) - Method in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- setAllowPermanentUnlockCustomDuration(Boolean) - Method in class com.tapkey.mobile.model.PermissionDetails.PermanentUnlockPermissionDetails
- setAllowTemporaryUnlockCustomDuration(Boolean) - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- setAllowUnrestrictedTemporaryUnlockDuration(Boolean) - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- setAsyncResult(AsyncResult<? extends T>) - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Completes the
Promise
associated with this instance with the givenAsyncResult
. - setBaseUri(String) - Method in class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder
-
Overrides the default base URI of the Tapkey Trust Service.
- setBluetoothAdvertisingFormat(TapkeyBleAdvertisingFormat) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
- setBluetoothStack(BluetoothStack) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Reserved for internal use.
- setBuildString(String) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setCallerData(byte[]) - Method in class com.tapkey.mobile.tlcp.commands.AbstractCommandBuilder
-
Sets the caller data.
- setChunkSize(int) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- setCompatibleFromVersion(int) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setConfig(TapkeyEnvironmentConfig) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Overrides the default Tapkey environment configuration with the specified one.
- setContent(FirmwarePackage.FirmwareContent) - Method in class com.tapkey.mobile.model.FirmwarePackage
- setCustomCommandData(byte[]) - Method in class com.tapkey.mobile.tlcp.commands.AbstractTriggerLockCommandBuilder
-
Sets custom command data that will be passed to the locking device together with the command.
- setDefaultUnlockDurationSec(Integer) - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- setDiagnosticsHandler(DiagnosticsHandler) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Reserved for internal use.
- setDurationSec(Integer) - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
-
Sets the duration in seconds for how long the locking device should stay unlocked.
- setException(Exception) - Method in class com.tapkey.mobile.concurrent.PromiseSource
- setFileDescriptor(byte[]) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- setFirmwareData(byte[]) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- setFirmwareInfoId(String) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent
- setFwType(String) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setHttpRequestExecutor(AsyncHttpRequestExecutor) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Reserved for internal use.
- setId(String) - Method in class com.tapkey.mobile.model.Owner
- setInfo(FirmwarePackage.FirmwareInfo) - Method in class com.tapkey.mobile.model.FirmwarePackage
- setLockTimeAsync(TlcpConnection, long, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- setLogger(Logger) - Static method in class com.tapkey.mobile.utils.Logs
- setManufacturerId(Integer) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setMaxCustomUnlockDurationSec(Integer) - Method in class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- setName(String) - Method in class com.tapkey.mobile.model.Owner
- setPermanentUnlockDetails(PermissionDetails.PermanentUnlockPermissionDetails) - Method in class com.tapkey.mobile.model.PermissionDetails
- setPushNotificationTokenProvider(PushNotificationTokenProvider) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Sets the application's push notification provider.
- setReleaseDate(Date) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setReleaseLevel(Integer) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setReleaseNotes(String) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setResult(T) - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Completes the
Promise
associated with this instance with the given value. - setServerClock(ServerClock) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Overrides the internal server clock used by various components of the SDK.
- setSystemClock(Clock) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Overrides the system clock.
- setTemporaryUnlockDetails(PermissionDetails.TemporaryUnlockPermissionDetails) - Method in class com.tapkey.mobile.model.PermissionDetails
- setTenantId(String) - Method in class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder
-
Overrides the default tenant ID.
- setTokenRefreshHandler(TokenRefreshHandler) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Sets the application's token refresh handler.
- setUnlockDurationSec(Integer) - Method in class com.tapkey.mobile.tlcp.commands.TemporaryTriggerUnlockCommandBuilder
-
Sets the unlock duration in seconds.
- setUntilUtc(Date) - Method in class com.tapkey.mobile.tlcp.commands.AbstractPermanentUnlockTriggerLockCommandBuilder
-
Sets the time in UTC until when the locking device should stay open.
- setVersionCode(int) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setVersionName(String) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo
- setWebSocketFactory(WebSocketFactory) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Reserved for internal use.
- startForegroundScan() - Method in interface com.tapkey.mobile.ble.BleLockScanner
-
Starts scanning for nearby Tapkey locks.
- SupportManager - Interface in com.tapkey.mobile.manager
-
The support manager provides access to information about the current environment.
- switchToScheduler(AsyncScheduler, AsyncScheduler, Func<Promise<T>, RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Starts an async function on the specified scheduler and continues the returned promise on the other specified scheduler.
- switchToScheduler(AsyncScheduler, Func<Promise<T>, RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Starts an async function on the specified scheduler and continues the returned promise on the caller's current scheduler.
- SyncLockCommandResult - Class in com.tapkey.mobile.model
-
The result of a synchronize lock command, returned by the Tapkey Trust Service.
- SyncLockCommandResult(ValidityError) - Constructor for class com.tapkey.mobile.model.SyncLockCommandResult
- syncLockOfflineAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- syncLockOnlineAsync(String, TlcpConnection, Integer, Action1<Float, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Synchronizes the lock.
T
- TAPKEY_PUSH_NOTIFICATION_IDENTIFIER - Static variable in interface com.tapkey.mobile.manager.PushNotificationManager
-
Push notification data sent by Tapkey will contain this identifier as key.
- TapkeyAdvertisingData - Class in com.tapkey.mobile.ble
-
Tapkey-specific advertising data.
- TapkeyAdvertisingData(byte[]) - Constructor for class com.tapkey.mobile.ble.TapkeyAdvertisingData
- TapkeyAppContext - Interface in com.tapkey.mobile
-
The
Application
class of an Android app using the Tapkey Mobile SDK must implement this interface. - TapkeyBleAdvertisingFormat - Interface in com.tapkey.mobile.ble
-
Specification of the format of Tapkey-specific advertising data.
- TapkeyBleAdvertisingFormatBuilder - Class in com.tapkey.mobile.ble
-
Builder for
TapkeyBleAdvertisingFormat
objects. - TapkeyBleAdvertisingFormatBuilder() - Constructor for class com.tapkey.mobile.ble.TapkeyBleAdvertisingFormatBuilder
- TapkeyBleAdvertisingParser - Interface in com.tapkey.mobile.ble
-
Parser for Tapkey-specific advertising data.
- TapkeyBleGattServiceConfig - Class in com.tapkey.mobile.ble
-
Bluetooth GATT service configuration as used by Tapkey.
- TapkeyBleGattServiceConfig(String, String, String) - Constructor for class com.tapkey.mobile.ble.TapkeyBleGattServiceConfig
- TapkeyBleGattServiceConfigProvider - Interface in com.tapkey.mobile.ble
-
Provider of Tapkey-specific service configuration data.
- TapkeyEndpointConfig - Interface in com.tapkey.mobile
-
Defines the Tapkey Trust Service endpoint to use for the Tapkey Mobile SDK.
- TapkeyEnvironmentConfig - Interface in com.tapkey.mobile
-
Defines the environment for the Tapkey Mobile SDK.
- TapkeyEnvironmentConfigBuilder - Class in com.tapkey.mobile
-
This class provides a Tapkey environment configuration.
- TapkeyEnvironmentConfigBuilder() - Constructor for class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder
- TapkeyServiceFactory - Interface in com.tapkey.mobile
-
The Tapkey service factory provides access to core components of the Tapkey Mobile SDK.
- TapkeyServiceFactoryBuilder - Class in com.tapkey.mobile
-
This class is used to build a
TapkeyServiceFactory
. - TapkeyServiceFactoryBuilder(Application) - Constructor for class com.tapkey.mobile.TapkeyServiceFactoryBuilder
-
Constructs a Tapkey service factory builder.
- TechnicalError - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Some unspecific technical error has occurred.
- TechnicalError - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
Some unspecific technical error has occurred.
- TemporarilyUnauthorized - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The key is valid but access is denied due to ICAL restrictions of the grant.
- TemporarilyUnauthorized - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The key is valid but access is denied due to ICAL restrictions of the grant.
- TemporaryTriggerUnlockCommandBuilder - Class in com.tapkey.mobile.tlcp.commands
-
Allows building a command for temporary unlocking.
- TemporaryTriggerUnlockCommandBuilder() - Constructor for class com.tapkey.mobile.tlcp.commands.TemporaryTriggerUnlockCommandBuilder
- TemporaryUnlock - com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Unlock the lock for the short amount of opening.
- TemporaryUnlockPermissionDetails() - Constructor for class com.tapkey.mobile.model.PermissionDetails.TemporaryUnlockPermissionDetails
- throwIfCancellationRequested() - Method in interface com.tapkey.mobile.concurrent.CancellationToken
-
Throws an exception in case
CancellationToken.isCancellationRequested()
evaluates to true. - TkErrorDescriptor - Class in com.tapkey.mobile.model
-
Contains information about an error that occurred in a component inside the SDK.
- TkErrorDescriptor(String, String, Object) - Constructor for class com.tapkey.mobile.model.TkErrorDescriptor
-
Creates an error descriptor.
- TkException - Exception in com.tapkey.mobile.error
-
TkException is used to represent exceptions inside many of the SDK's components.
- TkException() - Constructor for exception com.tapkey.mobile.error.TkException
-
Creates an empty TkException.
- TkException(TkErrorDescriptor) - Constructor for exception com.tapkey.mobile.error.TkException
-
Creates a new TkException with the given error descriptor.
- TkException(String) - Constructor for exception com.tapkey.mobile.error.TkException
-
Creates a TkException with the given error code.
- TlcpConnection - Class in com.tapkey.mobile.tlcp
-
Represents a TLCP (Tapkey Lock Control Protocol) connection to a lock.
- TlcpConnection(ServerClock, TlcpMessageConnection, TransportChannel) - Constructor for class com.tapkey.mobile.tlcp.TlcpConnection
-
Do not use.
- TokenRefreshFailed - Static variable in class com.tapkey.mobile.auth.AuthenticationHandlerErrorCodes
-
Indicates a non-recoverable situation, where an access token cannot be renewed and the SDK should not continue to make attempts to renew the authentication information.
- TokenRefreshHandler - Interface in com.tapkey.mobile.auth
-
Handles refreshing of authentication information.
- transceiveAsync(List<TapkeyRecord>, CertificateStore, CancellationToken) - Method in class com.tapkey.mobile.tlcp.TlcpConnection
-
Reserved for internal use.
- triggerLockAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Triggers the lock.
- trySetAsyncResult(AsyncResult<? extends T>) - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Tries to complete the
Promise
associated with this instance with the givenAsyncResult
. - trySetException(Exception) - Method in class com.tapkey.mobile.concurrent.PromiseSource
- trySetResult(T) - Method in class com.tapkey.mobile.concurrent.PromiseSource
-
Tries to complete the
Promise
associated with this instance with the given value. - Tuple<T1,T2> - Class in com.tapkey.mobile.utils
-
Class which provides a data structure that represents a pair consisting of two elements.
- Tuple(T1, T2) - Constructor for class com.tapkey.mobile.utils.Tuple
-
Constructs a tuple of two elements.
U
- Unauthorized - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Communication with the security backend succeeded but the user is not authorized for the given command on this locking device.
- Unauthorized - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The user is not authorized for the given command on this locking device.
- Unauthorized_NotYetValid - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The key is not yet valid but will be in the future.
- UnauthorizedAtThisTime - com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
The present key is considered not yet valid or expired.
- unbindLockLocalAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- unbindLockOnlineAsync(TlcpConnection, Integer, Action1<Float, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- Unknown - com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
- UnknownTagType - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
The lock is not a known Tapkey lock.
- updateAccessToken(String, String) - Method in interface com.tapkey.mobile.manager.UserManager
-
Replaces the access token for the specified user.
- Updated - com.tapkey.mobile.manager.KeyManager.KeyChangedType
- updateRegistrationToken(String) - Method in interface com.tapkey.mobile.manager.PushNotificationManager
-
To be called, when the push notification registration token has changed.
- upgradeFirmware(TlcpConnection, FirmwarePackage, int, Action1<CommandExecutionFacade.FirmwareUpgradeProgress, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Installs the specified firmware package on the lock.
- uploadFirmware(TlcpConnection, FirmwarePackage, int, Action1<CommandExecutionFacade.FirmwareUpgradeProgress, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- UserCommandResult(String, CommandResult.UserCommandResult.UserCommandResultCode, Object) - Constructor for class com.tapkey.mobile.model.CommandResult.UserCommandResult
- UserGrant - Class in com.tapkey.mobile.model
-
A Grant from the perspective of the receiving user.
- UserGrant(String, Date, Date, String, Owner, BoundLock, PermissionDetails) - Constructor for class com.tapkey.mobile.model.UserGrant
- UserManager - Interface in com.tapkey.mobile.manager
-
The user manager takes care of user authentication and provides access to the currently logged-in users.
- UserSpecificError - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
An error occurred on user level.
V
- valueOf(String) - Static method in enum com.tapkey.mobile.concurrent.LoopResult
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.tapkey.mobile.manager.KeyManager.KeyChangedType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.tapkey.mobile.concurrent.LoopResult
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.tapkey.mobile.manager.KeyManager.KeyChangedType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.tapkey.mobile.model.PermissionDetails.TriggerLockActionTypes
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VERBOSE - Static variable in class com.tapkey.mobile.utils.Logs
-
Priority constant for the println method; use Log.v.
W
- waitForTagLost(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- waitForTagLost(NdefConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade
-
Reserved for internal use.
- WARN - Static variable in class com.tapkey.mobile.utils.Logs
-
Priority constant for the println method; use Log.w.
- whenAll(Promise<? extends T>, Promise<? extends T>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for all specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - whenAll(Promise<? extends T>, Promise<? extends T>, Promise<? extends T>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for all specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - whenAll(List<? extends Promise<? extends T>>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for all specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - whenAllWithAsyncResults(Promise<? extends T>, Promise<? extends T>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for all specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - whenAllWithAsyncResults(Promise<? extends T>, Promise<? extends T>, Promise<? extends T>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for all specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - whenAllWithAsyncResults(List<? extends Promise<? extends T>>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for all specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - whenAny(Promise<? extends T>...) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for the first of the specified promises to complete, regardless, whether it completes successfully or with an
Exception
. - whenAny(List<? extends Promise<? extends T>>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for the first of the specified promises to complete, regardless, whether it completes successfully or with an
Exception
. - whenBoth(Promise<? extends T1>, Promise<? extends T2>) - Static method in class com.tapkey.mobile.concurrent.Async
-
Asynchronously waits for the specified promises to complete, regardless, whether they complete successfully or with an
Exception
. - withSettings(Promise<Void>, AsyncTaskSettings) - Static method in class com.tapkey.mobile.concurrent.Async
-
for internal use
- withTimeout(CancellationToken, int) - Static method in class com.tapkey.mobile.concurrent.CancellationTokens
-
Creates a cancellation token that goes into cancelled state when either the specified timeout period elapsed or the specified token goes into cancelled state, whatever happens first.
- WrongLockMode - com.tapkey.mobile.model.CommandResult.CommandResultCode
-
Lock is in the wrong mode for this command (e.g.
All Classes All Packages