UNPKG

react-native-inhouse-sdk

Version:
398 lines (397 loc) 45.8 kB
<!DOCTYPE html> <html class="no-js"> <head> <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> <title>TrackingSDK</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/TrackingSDK///PointingToDeclaration//-634080579"> <div class="breadcrumbs"><a href="../../../index.html">client</a><span class="delimiter">/</span><a href="../index.html">co.tryinhouse.android</a><span class="delimiter">/</span><span class="current">TrackingSDK</span></div> <div class="cover "> <h1 class="cover"><span>Tracking</span><wbr></wbr><span><span>SDK</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">class </span><a href="index.html">TrackingSDK</a></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="TYPE"> <h2 class="">Types</h2> <div class="table"><a data-name="-2039142916%2FClasslikes%2F-634080579" anchor-label="Companion" id="-2039142916%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="-companion/index.html"><span><span>Companion</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2039142916%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">object </span><a href="-companion/index.html">Companion</a></div></div></div> </div> </div> </div> </div> </div> </div> <div data-togglable="PROPERTY"> <h2 class="">Properties</h2> <div class="table"><a data-name="1891016899%2FProperties%2F-634080579" anchor-label="config" id="1891016899%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="config.html"><span><span>config</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1891016899%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">var </span><a href="config.html">config</a><span class="token operator">: </span><a href="../../co.tryinhouse.android.models/-s-d-k-config/index.html">SDKConfig</a><span class="token operator">?</span></div></div></div> </div> </div> </div> </div> </div> </div> <div data-togglable="FUNCTION"> <h2 class="">Functions</h2> <div class="table"><a data-name="-2021634894%2FFunctions%2F-634080579" anchor-label="debugFirstInstallState" id="-2021634894%2FFunctions%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="debug-first-install-state.html"><span>debug</span><wbr></wbr><span>First</span><wbr></wbr><span>Install</span><wbr></wbr><span><span>State</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2021634894%2FFunctions%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">fun </span><a href="debug-first-install-state.html"><span class="token function">debugFirstInstallState</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> <a data-name="175553309%2FFunctions%2F-634080579" anchor-label="fetchInstallReferrer" id="175553309%2FFunctions%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="fetch-install-referrer.html"><span>fetch</span><wbr></wbr><span>Install</span><wbr></wbr><span><span>Referrer</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="175553309%2FFunctions%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">fun </span><a href="fetch-install-referrer.html"><span class="token function">fetchInstallReferrer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">callback<span class="token operator">: </span><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 class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Fetches the install referrer from the Play Store API (async). Calls the callback with the referrer string or null.</p></div></div></div> </div> </div> </div> </div> <a data-name="41436704%2FFunctions%2F-634080579" anchor-label="getApplicationContext" id="41436704%2FFunctions%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="get-application-context.html"><span>get</span><wbr></wbr><span>Application</span><wbr></wbr><span><span>Context</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="41436704%2FFunctions%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">fun </span><a href="get-application-context.html"><span class="token function">getApplicationContext</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Expose application context for SDK internals that require it</p></div></div></div> </div> </div> </div> </div> <a data-name="-1547860722%2FFunctions%2F-634080579" anchor-label="getDeviceId" id="-1547860722%2FFunctions%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="get-device-id.html"><span>get</span><wbr></wbr><span>Device</span><wbr></wbr><span><span>Id</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1547860722%2FFunctions%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">fun </span><a href="get-device-id.html"><span class="token function">getDeviceId</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><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="869154209%2FFunctions%2F-634080579" anchor-label="getInstallReferrer" id="869154209%2FFunctions%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="get-install-referrer.html"><span>get</span><wbr></wbr><span>Install</span><wbr></wbr><span><span>Referrer</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="869154209%2FFunctions%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">fun </span><a href="get-install-referrer.html"><span class="token function">getInstallReferrer</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><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></div><div class="brief "><p class="paragraph">Returns the stored install referrer string, or null if not available.</p></div></div></div> </div> </div> </div> </div> <a data-name="1187656842%2FFunctions%2F-634080579" anchor-label="getSessionId" id="1187656842%2FFunctions%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="get-session-id.html"><span>get</span><wbr></wbr><span>Session</span><wbr></wbr><span><span>Id</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1187656842%2FFunctions%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">fun </span><a href="get-session-id.html"><span class="token function">getSessionId</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><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="-1461647267%2FFunctions%2F-634080579" anchor-label="initialize" id="-1461647267%2FFunctions%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="initialize.html"><span><span>initialize</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1461647267%2FFunctions%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">fun </span><a href="initialize.html"><span class="token function">initialize</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Context.html">Context</a><span class="token punctuation">, </span></span><span class="parameter ">projectId<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 ">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 ">callback<span class="token operator">: </span><span class="token punctuation">(</span>callbackType<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>jsonData<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 class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Initialize the SDK with project token and shortlink domain</p></div></div></div> </div> </div> </div> </div> <a data-name="-251095290%2FFunctions%2F-634080579" anchor-label="onAppResume" id="-251095290%2FFunctions%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="on-app-resume.html"><span>on</span><wbr></wbr><span>App</span><wbr></wbr><span><span>Resume</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-251095290%2FFunctions%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">fun </span><a href="on-app-resume.html"><span class="token function">onAppResume</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Call this method when the app comes to the foreground (onResume) This will check if the app was opened from a shortlink</p></div></div></div> </div> </div> </div> </div> <a data-name="-1422001093%2FFunctions%2F-634080579" anchor-label="onNewIntent" id="-1422001093%2FFunctions%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="on-new-intent.html"><span>on</span><wbr></wbr><span>New</span><wbr></wbr><span><span>Intent</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1422001093%2FFunctions%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">fun </span><a href="on-new-intent.html"><span class="token function">onNewIntent</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">intent<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/content/Intent.html">Intent</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> <a data-name="1041934907%2FFunctions%2F-634080579" anchor-label="resetFirstInstall" id="1041934907%2FFunctions%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="reset-first-install.html"><span>reset</span><wbr></wbr><span>First</span><wbr></wbr><span><span>Install</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1041934907%2FFunctions%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">fun </span><a href="reset-first-install.html"><span class="token function">resetFirstInstall</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> <a data-name="334758047%2FFunctions%2F-634080579" anchor-label="setCurrentActivity" id="334758047%2FFunctions%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="set-current-activity.html"><span>set</span><wbr></wbr><span>Current</span><wbr></wbr><span><span>Activity</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="334758047%2FFunctions%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">fun </span><a href="set-current-activity.html"><span class="token function">setCurrentActivity</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">activity<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span></div></div></div> </div> </div> </div> </div> <a data-name="73618083%2FFunctions%2F-634080579" anchor-label="trackAppInstallFromShortLink" id="73618083%2FFunctions%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="track-app-install-from-short-link.html"><span>track</span><wbr></wbr><span>App</span><wbr></wbr><span>Install</span><wbr></wbr><span>From</span><wbr></wbr><span>Short</span><wbr></wbr><span><span>Link</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="73618083%2FFunctions%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">fun </span><a href="track-app-install-from-short-link.html"><span class="token function">trackAppInstallFromShortLink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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="290096261%2FFunctions%2F-634080579" anchor-label="trackAppOpen" id="290096261%2FFunctions%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="track-app-open.html"><span>track</span><wbr></wbr><span>App</span><wbr></wbr><span><span>Open</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="290096261%2FFunctions%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">fun </span><a href="track-app-open.html"><span class="token function">trackAppOpen</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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="-767584274%2FFunctions%2F-634080579" anchor-label="trackAppOpenFromShortLink" id="-767584274%2FFunctions%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="track-app-open-from-short-link.html"><span>track</span><wbr></wbr><span>App</span><wbr></wbr><span>Open</span><wbr></wbr><span>From</span><wbr></wbr><span>Short</span><wbr></wbr><span><span>Link</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-767584274%2FFunctions%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">fun </span><a href="track-app-open-from-short-link.html"><span class="token function">trackAppOpenFromShortLink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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="-2120259240%2FFunctions%2F-634080579" anchor-label="trackCustomEvent" id="-2120259240%2FFunctions%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="track-custom-event.html"><span>track</span><wbr></wbr><span>Custom</span><wbr></wbr><span><span>Event</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2120259240%2FFunctions%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">fun </span><a href="track-custom-event.html"><span class="token function">trackCustomEvent</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">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 ">additionalData<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">&lt;</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">&gt;</span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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="1675148332%2FFunctions%2F-634080579" anchor-label="trackSessionStart" id="1675148332%2FFunctions%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="track-session-start.html"><span>track</span><wbr></wbr><span>Session</span><wbr></wbr><span><span>Start</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1675148332%2FFunctions%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">fun </span><a href="track-session-start.html"><span class="token function">trackSessionStart</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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="2108460309%2FFunctions%2F-634080579" anchor-label="trackSessionStartFromShortLink" id="2108460309%2FFunctions%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="track-session-start-from-short-link.html"><span>track</span><wbr></wbr><span>Session</span><wbr></wbr><span>Start</span><wbr></wbr><span>From</span><wbr></wbr><span>Short</span><wbr></wbr><span><span>Link</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2108460309%2FFunctions%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">fun </span><a href="track-session-start-from-short-link.html"><span class="token function">trackSessionStartFromShortLink</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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="1989267639%2FFunctions%2F-634080579" anchor-label="trackShortLinkClick" id="1989267639%2FFunctions%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="track-short-link-click.html"><span>track</span><wbr></wbr><span>Short</span><wbr></wbr><span>Link</span><wbr></wbr><span><span>Click</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1989267639%2FFunctions%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">fun </span><a href="track-short-link-click.html"><span class="token function">trackShortLinkClick</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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 ">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 ">callback<span class="token operator">: </span><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 punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-unit/index.html">Unit</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> </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>