A B C D E F G H I K L N O P Q R S T U V W

A

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.

addObserver(Action1<T, ? extends RuntimeException>) - Method in interface com.tapkey.mobile.utils.Observable

Adds an observer to the set of observers for this object.

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

Converts this Promise into one returning null of type Void.

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.

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 given Exception.

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

B

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[], boolean, 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.

build() - Method in class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder

Builds the TapkeyEnvironment configuration.

build() - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder

Builds the service factory.

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.tlcp - package com.tapkey.mobile.tlcp

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

Reserved for internal use.

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.

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.

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.

D

deactivateAdminModeAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade

Reserved for internal use.

DEFAULT_INTERVAL - Static variable in class com.tapkey.mobile.broadcast.PollingScheduler

The default polling interval of eight hours.

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 given CancellationToken requested cancellation.

downloadFirmwareContentAsync(String, String, String, CancellationToken) - Method in interface com.tapkey.mobile.manager.FirmwareManager

E

equals(Object) - Method in class com.tapkey.mobile.model.BleLock

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.

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.

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

Synchronously executes the given Action and then returns a completed Promise that resolves to null.

first(Func<T, ? extends Exception>) - Static method in class com.tapkey.mobile.concurrent.Async

Synchronously executes the given Func and then returns a completed Promise that resolves to the value returned by the function.

firstAsync(Func<Promise<T>, RuntimeException>) - Static method in class com.tapkey.mobile.concurrent.Async

Executes the given Func and returns the Promise returned by the function.

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

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.

getBleServiceUuid() - Method in interface com.tapkey.mobile.TapkeyEnvironmentConfig

Returns the Bluetooth service UUID to be used for Tapkey.

getBluetoothAddress() - Method in class com.tapkey.mobile.model.BleLock

Returns the lock's Bluetooth address.

getBuildString() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo

getBuildString() - Method in class com.tapkey.mobile.model.LockState

getCallerStackTrace() - Method in class com.tapkey.mobile.concurrent.PromiseSource

for internal use

getChunkSize() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent

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

getCustomCommandDescriptorsAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade

Reserved for internal use.

getDeviceSerialNo() - Method in class com.tapkey.mobile.model.LockState

getDiagnosticsHandler() - Method in interface com.tapkey.mobile.TapkeyServiceFactory

for internal use

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.KeyDetails

Deprecated.

as of version 2. Use KeyDetails.getGrantId() instead, and use the Management API to query for Grant details.

getGrantId() - Method in class com.tapkey.mobile.model.KeyDetails

Returns the corresponding grant's ID.

getHttpAuthenticationProvider() - Method in interface com.tapkey.mobile.manager.UserManager

Reserved for internal use.

getIncompleteLockId() - Method in class com.tapkey.mobile.model.BleLock

The lock 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.

getLock(String) - Method in interface com.tapkey.mobile.ble.BleLockScanner

Returns the BLE lock representation of the lock with the specified lock ID.

getLock(byte[]) - 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.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.

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

getManufactureId() - Method in class com.tapkey.mobile.model.LockState

getManufacturerId() - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo

getMaxSize() - Method in class com.tapkey.mobile.tlcp.TlcpConnection

Reserved for internal use.

getMessage() - Method in exception com.tapkey.mobile.error.TkException

Returns the exception's error message.

getModelName() - Method in class com.tapkey.mobile.model.LockState

getNofChunksCompleted() - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade.FirmwareUpgradeProgress

getNotificationManager() - Method in interface com.tapkey.mobile.TapkeyServiceFactory

Returns the notification manager that is used for polling information from the Tapkey Trust Service.

getProgress() - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade.FirmwareUpgradeProgress

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.

getQueriedAt() - Method in class com.tapkey.mobile.model.PublicStateInfo

Returns the server clock time when the lock's public state was retrieved.

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.

getServerTime() - Method in class com.tapkey.mobile.model.CommandResult

Returns the time on the Tapkey Trust Service when the command was executed.

getSession() - Method in class com.tapkey.mobile.tlcp.TlcpConnection

Reserved for internal use.

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

getTenantId() - Method in interface com.tapkey.mobile.TapkeyEndpointConfig

Returns the Tapkey Trust Service tenant to use.

getTimeSpan() - Method in class com.tapkey.mobile.model.LockState

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.

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.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.KeyDetails

Returns until when this mobile key is valid.

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

H

hasActivationStarted() - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade.FirmwareUpgradeProgress

hashCode() - Method in class com.tapkey.mobile.model.BleLock

I

invoke() - Method in interface com.tapkey.mobile.utils.Action

Invokes the action.

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.

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.

isBound() - Method in class com.tapkey.mobile.model.CommandResult

Returns whether the lock is bound or not.

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

isLockIdComplete() - Method in class com.tapkey.mobile.model.BleLock

Returns whether the lock ID is complete or not.

isLockNearby(String) - Method in interface com.tapkey.mobile.ble.BleLockScanner

Returns whether the Tapkey lock with the specified physical lock ID is nearby.

isLockNearby(byte[]) - 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 isLockNearby(String), but with configurable RSSI threshold.

isLockNearby(byte[], int) - Method in interface com.tapkey.mobile.ble.BleLockScanner

Same as isLockNearby(byte[]), 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

K

KeyDetails - Class in com.tapkey.mobile.model

A set of information on a locally available mobile key.

KeyDetails(String, Grant, 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.

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

LockState - Class in com.tapkey.mobile.model

Reserved for internal use.

LockState(byte[], String, int, String, int, Long, Date, Long, boolean, Double, Double, Double, String, String, String, boolean, boolean, Integer, String, int) - Constructor for class com.tapkey.mobile.model.LockState

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.

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 than LoopResult.Continue or null (i.e.

LoopResult - Enum in com.tapkey.mobile.concurrent

The outcome of a single iteration of a control loop.

N

None - Static variable in class com.tapkey.mobile.concurrent.CancellationTokens

A cancellation token that will never be cancelled.

NotificationManager - Interface in com.tapkey.mobile.manager

Provides methods to poll for updates from the Tapkey Trust Service.

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.

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.

P

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

Q

queryLocalKeysAsync(String, CancellationToken) - Method in interface com.tapkey.mobile.manager.KeyManager

Returns all mobile keys available for the specified user on this device.

queryPublicStateAsync(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade

Reserved for internal use.

R

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(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.

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.

requestCancellation() - Method in class com.tapkey.mobile.concurrent.CancellationTokenSource

Requests cancellation of the affected promises.

S

setAsyncResult(AsyncResult<? extends T>) - Method in class com.tapkey.mobile.concurrent.PromiseSource

Completes the Promise associated with this instance with the given AsyncResult.

setBaseUri(String) - Method in class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder

Overrides the default base URI of the Tapkey Trust Service.

setBleServiceUuid(String) - Method in class com.tapkey.mobile.TapkeyEnvironmentConfigBuilder

Overrides the default BLE service UUID to use.

setBuildString(String) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo

setChunkSize(int) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareContent

setCloudMessagingManager(CloudMessagingManager) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder

Reserved for internal use.

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

setDiagnosticsHandler(DiagnosticsHandler) - Method in class com.tapkey.mobile.TapkeyServiceFactoryBuilder

Reserved for internal use.

setException(Exception) - Method in class com.tapkey.mobile.concurrent.PromiseSource

Exceptionally completes the Promise associated with this instance with the given Exception.

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.

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.

setManufacturerId(Integer) - Method in class com.tapkey.mobile.model.FirmwarePackage.FirmwareInfo

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.

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.

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, 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.

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.

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

TapkeyAppContext - Interface in com.tapkey.mobile

The Application class of an Android app using the Tapkey Mobile SDK must implement this interface.

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(Context) - 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.

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(String) - Constructor for exception com.tapkey.mobile.error.TkException

Creates a TkException with the given error code.

TkException(TkErrorDescriptor) - Constructor for exception com.tapkey.mobile.error.TkException

Creates a new TkException with the given error descriptor.

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 given AsyncResult.

trySetException(Exception) - Method in class com.tapkey.mobile.concurrent.PromiseSource

Tries to exceptionally complete the Promise associated with this instance with the given Exception.

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

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.

updateAccessToken(String, String) - Method in interface com.tapkey.mobile.manager.UserManager

Replaces the access token for the specified user.

upgradeFirmware(TlcpConnection, FirmwarePackage, int, Action1<CommandExecutionFacade.FirmwareUpgradeProgress, RuntimeException>, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade

Reserved for internal use.

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

UserManager - Interface in com.tapkey.mobile.manager

The user manager takes care of user authentication and provides access to the currently logged-in users.

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.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.

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.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.

W

waitForTagLost(NdefConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade

Reserved for internal use.

waitForTagLost(TlcpConnection, CancellationToken) - Method in interface com.tapkey.mobile.manager.CommandExecutionFacade

Reserved for internal use.

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.

A B C D E F G H I K L N O P Q R S T U V W