Updated docs and examples
This commit is contained in:
parent
a8855096b3
commit
4900d5a342
GPG key ID:
776702A6A2DA330E
148 changed files with 5414 additions and 728 deletions
|
|
@ -45,7 +45,7 @@
|
|||
</a>
|
||||
</div>
|
||||
<div class="library-version">
|
||||
1.0.1 </div>
|
||||
2.0.0 </div>
|
||||
</div>
|
||||
<div class="filter-section" id="filter-section">
|
||||
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter="root/main">JVM</button>
|
||||
|
|
@ -61,15 +61,15 @@
|
|||
<div class="sidebar--inner" id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="Bitly Shorten::net.thauvin.erik.bitly/Bitlinks/clicks/#kotlin.String#net.thauvin.erik.bitly.Units#kotlin.Int#kotlin.Int#kotlin.String#kotlin.Boolean/PointingToDeclaration//-1617659094">
|
||||
<div class="main-content" data-page-type="member" id="content" pageIds="Bitly Shorten::net.thauvin.erik.bitly/Bitlinks/clicks/#kotlin.String#net.thauvin.erik.bitly.Units#kotlin.Int#kotlin.String#kotlin.Boolean/PointingToDeclaration//-1617659094">
|
||||
<div class="breadcrumbs"><a href="../../../index.html">Bitly Shorten</a><span class="delimiter">/</span><a href="../index.html">net.thauvin.erik.bitly</a><span class="delimiter">/</span><a href="index.html">Bitlinks</a><span class="delimiter">/</span><span class="current">clicks</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>clicks</span></span></h1>
|
||||
</div>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="clicks.html"><span class="token function">clicks</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bitlink<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">unit<span class="token operator">: </span><a href="../-units/index.html">Units</a><span class="token operator"> = </span>Units.DAY<span class="token punctuation">, </span></span><span class="parameter ">units<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>-1<span class="token punctuation">, </span></span><span class="parameter ">size<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">50</span><span class="token punctuation">, </span></span><span class="parameter ">unit_reference<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>Constants.EMPTY<span class="token punctuation">, </span></span><span class="parameter ">toJson<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin//net/thauvin/erik/bitly/Bitlinks.kt#L72">source</a>)</span></span></div><p class="paragraph">Returns the click counts for a specified Bitlink.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#getClicksSummaryForBitlink">Bitly API</a> for more information.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The click counts.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>bitlink</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A Bitlink made of the domain and hash.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>unit</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A <a href="../-units/index.html">unit of time</a>.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>units</span></span></u></div></span></div><div><div class="title"><p class="paragraph">An integer representing the time units to query data for. Pass -1 to return all units available.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>size</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The quantity of items to be be returned.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>unit_reference</span></span></u></div></span></div><div><div class="title"><p class="paragraph">An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>to</span><wbr></wbr><span><span>Json</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Returns the full JSON response if <code class="lang-kotlin">true</code>.</p></div></div></div></div></div></div></div>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable="root/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="clicks.html"><span class="token function">clicks</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bitlink<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">unit<span class="token operator">: </span><a href="../-units/index.html">Units</a><span class="token operator"> = </span>Units.DAY<span class="token punctuation">, </span></span><span class="parameter ">units<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>-1<span class="token punctuation">, </span></span><span class="parameter ">unit_reference<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span>Constants.EMPTY<span class="token punctuation">, </span></span><span class="parameter ">toJson<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin//net/thauvin/erik/bitly/Bitlinks.kt#L76">source</a>)</span></span></div><p class="paragraph">Returns the click counts for a specified Bitlink.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#getClicksSummaryForBitlink">Bitly API</a> for more information.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The click counts.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>bitlink</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A Bitlink made of the domain and hash.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>unit</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A <a href="../-units/index.html">unit of time</a>.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>units</span></span></u></div></span></div><div><div class="title"><p class="paragraph">An integer representing the time units to query data for. Pass -1 to return all units available.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>unit_reference</span></span></u></div></span></div><div><div class="title"><p class="paragraph">An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.</p></div></div></div></div><div class="table-row" data-filterable-current="root/main" data-filterable-set="root/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>to</span><wbr></wbr><span><span>Json</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Returns the full JSON response if <code class="lang-kotlin">true</code>.</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>© 2023 Copyright</span><span
|
||||
<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>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue