tgbotapi.webapps/dev.inmo.tgbotapi.webapps.storage/DeviceStorage

DeviceStorage

external interface DeviceStorage

This object is used to access the device's local storage.

See https://core.telegram.org/bots/webapps#devicestorage for more information.

Functions

clear

abstract fun clear(callback: (DeviceStorageErrorMessage?, Boolean?) -> Unit): DeviceStorage

Clears all key-value pairs from the storage.

clear

suspend fun DeviceStorage.clear(): Boolean

Clears all key-value pairs from the storage. This function suspends until the result is available and returns the result directly or throws an exception if an error occurred.

clearWithResult

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

Clears all key-value pairs from the storage. This function uses a CompletableDeferred to handle the asynchronous callback and returns a Result object.

getItem

abstract fun getItem(key: String, callback: (DeviceStorageErrorMessage?, String?) -> Unit): DeviceStorage

Retrieves the value associated with a key.

getItem

suspend fun DeviceStorage.getItem(key: String): String?

Retrieves the value associated with a key. This function suspends until the result is available and returns the result directly or throws an exception if an error occurred.

getWithResult

suspend fun DeviceStorage.getWithResult(key: String): Result<String?>

Retrieves the value associated with a key. This function uses a CompletableDeferred to handle the asynchronous callback and returns a Result object.

removeItem

abstract fun removeItem(key: String, callback: (DeviceStorageErrorMessage?, Boolean?) -> Unit): DeviceStorage

Removes the key-value pair associated with a key.

removeItem

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

Removes the key-value pair associated with a key. This function suspends until the result is available and returns the result directly or throws an exception if an error occurred.

removeWithResult

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

Removes the key-value pair associated with a key. This function uses a CompletableDeferred to handle the asynchronous callback and returns a Result object.

setItem

abstract fun setItem(key: String, value: String, callback: (DeviceStorageErrorMessage?, Boolean?) -> Unit): DeviceStorage

Stores a key-value pair.

setItem

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

Stores a key-value pair. This function suspends until the result is available and returns the result directly or throws an exception if an error occurred.

setWithResult

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

Stores a key-value pair. This function uses a CompletableDeferred to handle the asynchronous callback and returns a Result object.