UNPKG

react-native-inhouse-sdk

Version:
214 lines (213 loc) 21.1 kB
<!DOCTYPE html> <html class="no-js"> <head> <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> <title>SDKConfig</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="async"></script> <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="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"> <script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script> <script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script> <script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script> <script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script> <script type="text/javascript" src="../../../scripts/prism.js" async="async"></script> <script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script> </head> <body> <div class="root"> <nav class="navigation" id="navigation-wrapper"> <div class="navigation--inner"> <div class="navigation-title"> <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button> <div class="library-name"> <a class="library-name--link" href="../../../index.html"> client </a> </div> <div class="library-version"> </div> </div> <div class="filter-section" id="filter-section"> <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":client:dokkaHtml/release">androidJvm</button> </div> </div> <div class="navigation-controls"> <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button> <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div> </div> </nav> <div id="container"> <div class="sidebar" id="leftColumn"> <div class="sidebar--inner" id="sideMenu"></div> </div> <div id="main"> <div class="main-content" data-page-type="classlike" id="content" pageIds="client::co.tryinhouse.android.models/SDKConfig///PointingToDeclaration//-634080579"> <div class="breadcrumbs"><a href="../../../index.html">client</a><span class="delimiter">/</span><a href="../index.html">co.tryinhouse.android.models</a><span class="delimiter">/</span><span class="current">SDKConfig</span></div> <div class="cover "> <h1 class="cover"><span><span>SDKConfig</span></span></h1> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">SDKConfig</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>projectToken<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>tokenId<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>shortLinkDomain<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>serverUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;https://your-api-server.com&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>enableDebugLogging<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>sessionTimeoutMinutes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">30</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>maxRetryAttempts<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">3</span></span></span><span class="token punctuation">)</span></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></div> <div class="tabs-section-body"> <div data-togglable="CONSTRUCTOR"> <h2 class="">Constructors</h2> <div class="table"><a data-name="1020118111%2FConstructors%2F-634080579" anchor-label="SDKConfig" id="1020118111%2FConstructors%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-s-d-k-config.html"><span><span>SDKConfig</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1020118111%2FConstructors%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">projectToken<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">tokenId<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">shortLinkDomain<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">serverUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;https://your-api-server.com&quot;</span><span class="token punctuation">, </span></span><span class="parameter ">enableDebugLogging<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">sessionTimeoutMinutes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">30</span><span class="token punctuation">, </span></span><span class="parameter ">maxRetryAttempts<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">3</span></span></span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> </div> </div> <div data-togglable="PROPERTY"> <h2 class="">Properties</h2> <div class="table"><a data-name="665406529%2FProperties%2F-634080579" anchor-label="enableDebugLogging" id="665406529%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="enable-debug-logging.html"><span>enable</span><wbr></wbr><span>Debug</span><wbr></wbr><span><span>Logging</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="665406529%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="enable-debug-logging.html">enableDebugLogging</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></div></div></div> </div> </div> </div> </div> <a data-name="1658316038%2FProperties%2F-634080579" anchor-label="maxRetryAttempts" id="1658316038%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="max-retry-attempts.html"><span>max</span><wbr></wbr><span>Retry</span><wbr></wbr><span><span>Attempts</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1658316038%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="max-retry-attempts.html">maxRetryAttempts</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">3</span></div></div></div> </div> </div> </div> </div> <a data-name="1677623280%2FProperties%2F-634080579" anchor-label="projectToken" id="1677623280%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="project-token.html"><span>project</span><wbr></wbr><span><span>Token</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1677623280%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="project-token.html">projectToken</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a></div></div></div> </div> </div> </div> </div> <a data-name="516187230%2FProperties%2F-634080579" anchor-label="serverUrl" id="516187230%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="server-url.html"><span>server</span><wbr></wbr><span><span>Url</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="516187230%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="server-url.html">serverUrl</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a></div></div></div> </div> </div> </div> </div> <a data-name="-882068330%2FProperties%2F-634080579" anchor-label="sessionTimeoutMinutes" id="-882068330%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="session-timeout-minutes.html"><span>session</span><wbr></wbr><span>Timeout</span><wbr></wbr><span><span>Minutes</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-882068330%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="session-timeout-minutes.html">sessionTimeoutMinutes</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">30</span></div></div></div> </div> </div> </div> </div> <a data-name="1718397584%2FProperties%2F-634080579" anchor-label="shortLinkDomain" id="1718397584%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="short-link-domain.html"><span>short</span><wbr></wbr><span>Link</span><wbr></wbr><span><span>Domain</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1718397584%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="short-link-domain.html">shortLinkDomain</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a></div></div></div> </div> </div> </div> </div> <a data-name="1069428438%2FProperties%2F-634080579" anchor-label="tokenId" id="1069428438%2FProperties%2F-634080579" data-filterable-set=":client:dokkaHtml/release"></a> <div class="table-row" data-filterable-current=":client:dokkaHtml/release" data-filterable-set=":client:dokkaHtml/release"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="token-id.html"><span>token</span><wbr></wbr><span><span>Id</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1069428438%2FProperties%2F-634080579"></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=":client:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">val </span><a href="token-id.html">tokenId</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-string/index.html">String</a></div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="footer"> <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span> </div> </div> </div> </div> </body> </html>