@tryinhouse/react-native-inhouse-sdk

<!DOCTYPE html> <html class="no-js"> <head> <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> <title>co.tryinhouse.android.models</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="package" id="content" pageIds="client::co.tryinhouse.android.models////PointingToDeclaration//-634080579"> <div class="breadcrumbs"><a href="../../index.html">client</a><span class="delimiter">/</span><span class="current">co.tryinhouse.android.models</span></div> <div class="cover "> <h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1> </div> <div class="tabbedcontent"> <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button></div> <div class="tabs-section-body"> <div data-togglable="TYPE"> <h2 class="">Types</h2> <div class="table"><a data-name="-632397359%2FClasslikes%2F-634080579" anchor-label="Event" id="-632397359%2FClasslikes%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="-event/index.html"><span><span>Event</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-632397359%2FClasslikes%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">data </span><span class="token keyword">class </span><a href="-event/index.html">Event</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>eventType<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>shortLink<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 operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>deepLink<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 operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>timestamp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>System.currentTimeMillis()<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>deviceId<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>sessionId<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>extra<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-map/index.html">Map</a><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>userAgent<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 operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>ipAddress<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 operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>referrer<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 operator"> = </span>null</span></span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> <a data-name="-1128667290%2FClasslikes%2F-634080579" anchor-label="InstallData" id="-1128667290%2FClasslikes%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="-install-data/index.html"><span>Install</span><wbr></wbr><span><span>Data</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1128667290%2FClasslikes%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">data </span><span class="token keyword">class </span><a href="-install-data/index.html">InstallData</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>shortLink<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>keyValuePairs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-map/index.html">Map</a><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><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 punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>timestamp<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>System.currentTimeMillis()</span></span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> <a data-name="145197455%2FClasslikes%2F-634080579" anchor-label="SDKConfig" id="145197455%2FClasslikes%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="-s-d-k-config/index.html"><span><span>SDKConfig</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="145197455%2FClasslikes%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">data </span><span class="token keyword">class </span><a href="-s-d-k-config/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">"https://your-api-server.com"</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> </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>