InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2025-11-14 19:10:22 +00:00
Code Releases Activity
Files
47ab8cfc190b0549c0bcd28c4d1c879a05a7515a
tgbotapi/tgbotapi.webapps/dev.inmo.tgbotapi.webapps.storage/-secure-storage/index.html
InsanusMokrassar fa133e9574 deploy: de47497223
2025-06-01 16:44:47 +00:00

368 lines
46 KiB
HTML
Raw Blame History

<!doctype html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>SecureStorage</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<link href="../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
<script type="text/javascript" src="../../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../ui-kit/ui-kit.min.js" defer></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<div class="root">
<nav class="navigation theme-dark" id="navigation-wrapper">
<a class="library-name--link" href="../../../index.html">
ktgbotapi
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
</button>
<div class="navigation-controls--break ui-kit_mobile-only"></div>
<div class="library-version" id="library-version">
</div>
<div class="navigation-controls">
<div class="filter-section filter-section_loading" id="filter-section">
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">js</button>
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox" data-role="dropdown-toggle" aria-controls="platform-tags-listbox" aria-haspopup="listbox" aria-expanded="false" aria-label="Toggle source sets"></button>
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox">
<div class="dropdown--header"><span>Platform filter</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close platform filter">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<li role="option" class="dropdown--option platform-selector-option js-like" tabindex="0">
<label class="checkbox">
<input type="checkbox" class="checkbox--input" id=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filter=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<span class="checkbox--icon"></span>
js
</label>
</li>
</ul>
<div class="dropdown--overlay"></div>
</div>
</div>
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button" type="button">Switch theme
</button>
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
API
</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list" data-role="dropdown-listbox">
<div class="dropdown--header">
<span>
ktgbotapi
</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<div class="sidebar--inner" id="sideMenu"></div>
</ul>
<div class="dropdown--overlay"></div>
</div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageids="tgbotapi.webapps::dev.inmo.tgbotapi.webapps.storage/SecureStorage///PointingToDeclaration//155593271">
<div class="breadcrumbs"><a href="../../index.html">tgbotapi.webapps</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.tgbotapi.webapps.storage</a><span class="delimiter">/</span><span class="current">SecureStorage</span></div>
<div class="cover ">
<h1 class="cover"><span>Secure</span><wbr><span><span>Storage</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">external </span><span class="token keyword">class </span><a href="index.html">SecureStorage</a></div><p class="paragraph">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.</p><p class="paragraph">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.</p><p class="paragraph">For non-sensitive data, consider using <a href="../-device-storage/index.html">DeviceStorage</a>.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div></div></span></div><div><div class="title"><p class="paragraph"><a href="https://core.telegram.org/bots/webapps#securestorage">https://core.telegram.org/bots/webapps#securestorage</a></p></div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members &amp; Extensions</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="-1423414470%2FConstructors%2F155593271" anchor-label="SecureStorage" id="-1423414470%2FConstructors%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-secure-storage.html"><span>Secure</span><wbr><span><span>Storage</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1423414470%2FConstructors%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1439531809%2FFunctions%2F155593271" anchor-label="clear" id="1439531809%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="clear.html"><span><span>clear</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1439531809%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="clear.html"><span class="token function">clear</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">callback<span class="token operator">: </span><span class="token punctuation">(</span>error<span class="token operator">: </span><a href="../-secure-storage-error-message/index.html">SecureStorageErrorMessage</a><span class="token operator">?</span><span class="token punctuation">, </span>isSuccessful<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Clears all key-value pairs from the secure storage.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="878167170%2FFunctions%2F155593271" anchor-label="clear" id="878167170%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../clear.html"><span><span>clear</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="878167170%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../clear.html"><span class="token function">clear</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Clears all key-value pairs from secure storage. This suspending function handles the result directly and throws an exception if an error occurs.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="43062565%2FFunctions%2F155593271" anchor-label="clearWithResult" id="43062565%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../clear-with-result.html"><span>clear</span><wbr><span>With</span><wbr><span><span>Result</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="43062565%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../clear-with-result.html"><span class="token function">clearWithResult</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Clears all key-value pairs from the secure storage using a <span data-unresolved-link="kotlinx.coroutines/CompletableDeferred///PointingToDeclaration/">CompletableDeferred</span> and returns a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="395184577%2FFunctions%2F155593271" anchor-label="getItem" id="395184577%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="get-item.html"><span>get</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="395184577%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="get-item.html"><span class="token function">getItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token punctuation">(</span>error<span class="token operator">: </span><a href="../-secure-storage-error-message/index.html">SecureStorageErrorMessage</a><span class="token operator">?</span><span class="token punctuation">, </span>value<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span>canBeRestored<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">?</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Retrieves the value associated with a key from secure storage.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1565815354%2FFunctions%2F155593271" anchor-label="getItem" id="-1565815354%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../get-item.html"><span>get</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1565815354%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../get-item.html"><span class="token function">getItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.common/Either///PointingToDeclaration/">Either</span><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">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.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1120682006%2FFunctions%2F155593271" anchor-label="getWithResult" id="1120682006%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../get-with-result.html"><span>get</span><wbr><span>With</span><wbr><span><span>Result</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1120682006%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../get-with-result.html"><span class="token function">getWithResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator">&lt;</span><span data-unresolved-link="dev.inmo.micro_utils.common/Either///PointingToDeclaration/">Either</span><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Retrieves the value associated with a key from secure storage using a <span data-unresolved-link="kotlinx.coroutines/CompletableDeferred///PointingToDeclaration/">CompletableDeferred</span> and returns a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>. 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 <span data-unresolved-link="kotlinx.coroutines/CompletableDeferred///PointingToDeclaration/">CompletableDeferred</span> to manage the asynchronous result.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1101576174%2FFunctions%2F155593271" anchor-label="removeItem" id="-1101576174%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="remove-item.html"><span>remove</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1101576174%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="remove-item.html"><span class="token function">removeItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token punctuation">(</span>error<span class="token operator">: </span><a href="../-secure-storage-error-message/index.html">SecureStorageErrorMessage</a><span class="token operator">?</span><span class="token punctuation">, </span>isSuccessful<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Removes the key-value pair associated with a key from secure storage.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2096507270%2FFunctions%2F155593271" anchor-label="removeItem" id="2096507270%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../remove-item.html"><span>remove</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2096507270%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../remove-item.html"><span class="token function">removeItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">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.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-803009578%2FFunctions%2F155593271" anchor-label="removeWithResult" id="-803009578%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../remove-with-result.html"><span>remove</span><wbr><span>With</span><wbr><span><span>Result</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-803009578%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../remove-with-result.html"><span class="token function">removeWithResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Removes the key-value pair associated with a key from secure storage using a <span data-unresolved-link="kotlinx.coroutines/CompletableDeferred///PointingToDeclaration/">CompletableDeferred</span> and returns a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-502015584%2FFunctions%2F155593271" anchor-label="restoreItem" id="-502015584%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="restore-item.html"><span>restore</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-502015584%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="restore-item.html"><span class="token function">restoreItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token punctuation">(</span>error<span class="token operator">: </span><a href="../-secure-storage-error-message/index.html">SecureStorageErrorMessage</a><span class="token operator">?</span><span class="token punctuation">, </span>value<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Restores the value associated with a key in secure storage. This is useful if the value was previously removed using <a href="remove-item.html">removeItem</a> 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.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1695933710%2FFunctions%2F155593271" anchor-label="restoreItem" id="1695933710%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../restore-item.html"><span>restore</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1695933710%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../restore-item.html"><span class="token function">restoreItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">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.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="748290398%2FFunctions%2F155593271" anchor-label="restoreWithResult" id="748290398%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../restore-with-result.html"><span>restore</span><wbr><span>With</span><wbr><span><span>Result</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="748290398%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../restore-with-result.html"><span class="token function">restoreWithResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Restores the value associated with a key in secure storage using a <span data-unresolved-link="kotlinx.coroutines/CompletableDeferred///PointingToDeclaration/">CompletableDeferred</span> and returns a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="288015667%2FFunctions%2F155593271" anchor-label="setItem" id="288015667%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="set-item.html"><span>set</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="288015667%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-item.html"><span class="token function">setItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token punctuation">(</span>error<span class="token operator">: </span><a href="../-secure-storage-error-message/index.html">SecureStorageErrorMessage</a><span class="token operator">?</span><span class="token punctuation">, </span>isSuccessful<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Stores a key-value pair in secure storage.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="647182751%2FFunctions%2F155593271" anchor-label="setItem" id="647182751%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../set-item.html"><span>set</span><wbr><span><span>Item</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="647182751%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../set-item.html"><span class="token function">setItem</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Stores a key-value pair in secure storage. This suspending function handles the result directly and throws an exception if an error occurs.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="983480559%2FFunctions%2F155593271" anchor-label="setWithResult" id="983480559%2FFunctions%2F155593271" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":tgbotapi.webapps:dokkaHtmlPartial/jsMain" data-filterable-set=":tgbotapi.webapps:dokkaHtmlPartial/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../set-with-result.html"><span>set</span><wbr><span>With</span><wbr><span><span>Result</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="983480559%2FFunctions%2F155593271"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":tgbotapi.webapps:dokkaHtmlPartial/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="index.html">SecureStorage</a><span class="token punctuation">.</span><a href="../set-with-result.html"><span class="token function">setWithResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Stores a key-value pair in secure storage using a <span data-unresolved-link="kotlinx.coroutines/CompletableDeferred///PointingToDeclaration/">CompletableDeferred</span> and returns a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<span>© 2025 Copyright</span>
<span class="pull-right">
<span>Generated by </span>
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
<span>dokka</span>
</a>
</span>
</div>
</div>
</div>
</div>
</body>
</html>
View Git Blame Copy Permalink