Skip to content

Commit

Permalink
deploy: fdb4476
Browse files Browse the repository at this point in the history
  • Loading branch information
kodiakhq[bot] committed Feb 21, 2024
1 parent 76d5028 commit 43ef08c
Show file tree
Hide file tree
Showing 6 changed files with 101 additions and 5 deletions.
1 change: 1 addition & 0 deletions lib/package-list
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ $dokka.location:tech.relaycorp.awaladroid/GatewayBindingException///PointingToDe
$dokka.location:tech.relaycorp.awaladroid/GatewayBindingException/GatewayBindingException/#kotlin.String#kotlin.Throwable?/PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-binding-exception/-gateway-binding-exception.html
$dokka.location:tech.relaycorp.awaladroid/GatewayClientImpl///PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-client-impl/index.html
$dokka.location:tech.relaycorp.awaladroid/GatewayClientImpl/bind/#/PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-client-impl/bind.html
$dokka.location:tech.relaycorp.awaladroid/GatewayClientImpl/bindAutomatically/#kotlin.Function0[kotlin.Unit]#kotlin.Function0[kotlin.Unit]#kotlin.Function1[tech.relaycorp.awaladroid.GatewayBindingException,kotlin.Unit]/PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-client-impl/bind-automatically.html
$dokka.location:tech.relaycorp.awaladroid/GatewayClientImpl/receiveMessages/#/PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-client-impl/receive-messages.html
$dokka.location:tech.relaycorp.awaladroid/GatewayClientImpl/sendMessage/#tech.relaycorp.awaladroid.messaging.OutgoingMessage/PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-client-impl/send-message.html
$dokka.location:tech.relaycorp.awaladroid/GatewayClientImpl/unbind/#/PointingToDeclaration/lib/tech.relaycorp.awaladroid/-gateway-client-impl/unbind.html
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>bindAutomatically</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">
lib
</a>
</div>
<div class="library-version">
1.0.0a1 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":lib: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="member" id="content" pageIds="lib::tech.relaycorp.awaladroid/GatewayClientImpl/bindAutomatically/#kotlin.Function0[kotlin.Unit]#kotlin.Function0[kotlin.Unit]#kotlin.Function1[tech.relaycorp.awaladroid.GatewayBindingException,kotlin.Unit]/PointingToDeclaration//1946847589">
<div class="breadcrumbs"><a href="../../../index.html">lib</a><span class="delimiter">/</span><a href="../index.html">tech.relaycorp.awaladroid</a><span class="delimiter">/</span><a href="index.html">GatewayClientImpl</a><span class="delimiter">/</span><span class="current">bindAutomatically</span></div>
<div class="cover ">
<h1 class="cover"><span>bind</span><wbr></wbr><span><span>Automatically</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="bind-automatically.html"><span class="token function">bindAutomatically</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">onBindSuccessful<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onUnbind<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onBindFailure<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../-gateway-binding-exception/index.html">GatewayBindingException</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">The app will automatically bind when the application is in the foreground, and unbind when the app is moved to the background. Only call this method once.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":lib:dokkaHtml/release" data-filterable-set=":lib:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Bind</span><wbr></wbr><span><span>Successful</span></span></u></div></span></div><div><div class="title"><p class="paragraph">called on every successful bind to the gateway</p></div></div></div></div><div class="table-row" data-filterable-current=":lib:dokkaHtml/release" data-filterable-set=":lib:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span><span>Unbind</span></span></u></div></span></div><div><div class="title"><p class="paragraph">called on every unbind to the gateway</p></div></div></div></div><div class="table-row" data-filterable-current=":lib:dokkaHtml/release" data-filterable-set=":lib:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span>Bind</span><wbr></wbr><span><span>Failure</span></span></u></div></span></div><div><div class="title"><p class="paragraph">called if the binding failed, usually because the Gateway app is not installed on the device</p></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>© 2024 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>
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>bind</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="bind.html"><span class="token function">bind</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><p class="paragraph">Bind to the gateway to be able to communicate with it.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="bind.html"><span class="token function"><strike>bind</strike></span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="deprecation-content"><h3 class="">Deprecated</h3><p class="paragraph">Use bindAutomatically to bind/unbind when the app is in the foreground/background</p><h4 class="">Replace with</h4><div class="sample-container"><pre><code class="monospace block lang-kotlin" theme="idea">bindAutomatically()</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div><p class="paragraph">Bind to the gateway to be able to communicate with it.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
19 changes: 17 additions & 2 deletions lib/tech.relaycorp.awaladroid/-gateway-client-impl/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,22 @@ <h2 class="">Functions</h2>
</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=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="bind.html"><span class="token function">bind</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Bind to the gateway to be able to communicate with it.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="bind.html"><span class="token function"><strike>bind</strike></span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Bind to the gateway to be able to communicate with it.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1199411055%2FFunctions%2F1946847589" anchor-label="bindAutomatically" id="-1199411055%2FFunctions%2F1946847589" data-filterable-set=":lib:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":lib:dokkaHtml/release" data-filterable-set=":lib:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="bind-automatically.html"><span>bind</span><wbr></wbr><span><span>Automatically</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1199411055%2FFunctions%2F1946847589"></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=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="bind-automatically.html"><span class="token function">bindAutomatically</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">onBindSuccessful<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onUnbind<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onBindFailure<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../-gateway-binding-exception/index.html">GatewayBindingException</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">The app will automatically bind when the application is in the foreground, and unbind when the app is moved to the background. Only call this method once.</p></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -127,7 +142,7 @@ <h2 class="">Functions</h2>
</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=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="unbind.html"><span class="token function">unbind</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Unbind from the gateway.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="unbind.html"><span class="token function"><strike>unbind</strike></span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Unbind from the gateway.</p></div></div></div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<div class="cover ">
<h1 class="cover"><span><span>unbind</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="unbind.html"><span class="token function">unbind</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><p class="paragraph">Unbind from the gateway.</p><p class="paragraph">Make sure to call this when you no longer need to communicate with the gateway.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="unbind.html"><span class="token function"><strike>unbind</strike></span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="deprecation-content"><h3 class="">Deprecated</h3><p class="paragraph">Use bindAutomatically to bind/unbind when the app is in the foreground/background</p><h4 class="">Replace with</h4></div><p class="paragraph">Unbind from the gateway.</p><p class="paragraph">Make sure to call this when you no longer need to communicate with the gateway.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
2 changes: 1 addition & 1 deletion scripts/pages.json

Large diffs are not rendered by default.

0 comments on commit 43ef08c

Please sign in to comment.