tgbotapi.webapps/dev.inmo.tgbotapi.webapps.storage/SecureStorage

SecureStorage

This class provides access to the secure local storage, which is persistent and tied to the user's Telegram account. Data stored in secure storage is accessible only to the Web App that saved it.

Use this storage to save sensitive data like access tokens or user preferences that should persist across sessions. Keep in mind that storage size is limited to 2 kilobytes.

For non-sensitive data, consider using DeviceStorage.

Constructors

SecureStorage

constructor()

Functions

clear

fun clear(callback: (error: SecureStorageErrorMessage?, isSuccessful: Boolean) -> Unit)

Clears all key-value pairs from the secure storage.

clear

suspend fun SecureStorage.clear(): Boolean

Clears all key-value pairs from secure storage. This suspending function handles the result directly and throws an exception if an error occurs.

clearWithResult

suspend fun SecureStorage.clearWithResult(): Result<Boolean>

Clears all key-value pairs from the secure storage using a CompletableDeferred and returns a Result.

getItem

fun getItem(key: String, callback: (error: SecureStorageErrorMessage?, value: String?, canBeRestored: Boolean?) -> Unit)

Retrieves the value associated with a key from secure storage.

getItem

suspend fun SecureStorage.getItem(key: String): Either<String?, Boolean>

Retrieves the value associated with a key from secure storage. This function uses a callback-based approach for handling the asynchronous result of the operation.

getWithResult

suspend fun SecureStorage.getWithResult(key: String): Result<Either<String?, Boolean>>

Retrieves the value associated with a key from secure storage using a CompletableDeferred and returns a Result. This suspending function encapsulates the asynchronous operation of retrieving a value and provides a structured way to handle both successful retrieval and potential errors. It uses a CompletableDeferred to manage the asynchronous result.

removeItem

fun removeItem(key: String, callback: (error: SecureStorageErrorMessage?, isSuccessful: Boolean) -> Unit)

Removes the key-value pair associated with a key from secure storage.

removeItem

suspend fun SecureStorage.removeItem(key: String): Boolean

Removes the key-value pair associated with a key from secure storage. This suspending function handles the result directly and throws an exception if an error occurs.

removeWithResult

suspend fun SecureStorage.removeWithResult(key: String): Result<Boolean>

Removes the key-value pair associated with a key from secure storage using a CompletableDeferred and returns a Result.

restoreItem

fun restoreItem(key: String, callback: (error: SecureStorageErrorMessage?, value: String?) -> Unit)

Restores the value associated with a key in secure storage. This is useful if the value was previously removed using removeItem and needs to be retrieved again. Note that restoring a value is only possible if it hasn't been overwritten by a new value for the same key.

restoreItem

suspend fun SecureStorage.restoreItem(key: String): String?

Restores the value associated with a key in secure storage. This suspending function handles the result directly and throws an exception if an error occurs.

restoreWithResult

suspend fun SecureStorage.restoreWithResult(key: String): Result<String?>

Restores the value associated with a key in secure storage using a CompletableDeferred and returns a Result.

setItem

fun setItem(key: String, value: String, callback: (error: SecureStorageErrorMessage?, isSuccessful: Boolean) -> Unit)

Stores a key-value pair in secure storage.

setItem

suspend fun SecureStorage.setItem(key: String, value: String): Boolean

Stores a key-value pair in secure storage. This suspending function handles the result directly and throws an exception if an error occurs.

setWithResult

suspend fun SecureStorage.setWithResult(key: String, value: String): Result<Boolean>

Stores a key-value pair in secure storage using a CompletableDeferred and returns a Result.

SecureStorage

See also

Constructors

Functions