erik/bitly-shorten
erik/bitly-shorten
1
1
Fork 0
Code Issues Releases Activity

Fixed KDocs.

Browse source
This commit is contained in:
Erik C. Thauvin 2021-06-04 13:15:08 -07:00
parent cb346effa6
commit f492c712bd
7 changed files with 22 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html
View file

@ -28,7 +28,7 @@
<div> <div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="clicks.html">clicks</a>(bitlink: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, unit: <a href="../-units/index.html">Units</a> = Units.DAY, units: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = -1, size: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 50, unit_reference: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="clicks.html">clicks</a>(bitlink: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, unit: <a href="../-units/index.html">Units</a> = Units.DAY, units: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = -1, size: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 50, unit_reference: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div>
</div> </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><h4 class="">Return</h4><p class="paragraph">The click counts or JSON response object.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">bitlink</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A Bitlink made of the domain and hash.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">unit</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A <a href="../-units/index.html">unit of time</a>.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">units</span></div><div><div class="title"><div data-togglable="Parameters"><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><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">size</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The quantity of items to be be returned.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">unit_reference</span></div><div><div class="title"><div data-togglable="Parameters"><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><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code></p></div></div></div></div></div></div></div></div></div></div></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><h4 class="">Return</h4><p class="paragraph">The click counts.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">bitlink</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A Bitlink made of the domain and hash.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">unit</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A <a href="../-units/index.html">unit of time</a>.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">units</span></div><div><div class="title"><div data-togglable="Parameters"><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><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">size</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The quantity of items to be be returned.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">unit_reference</span></div><div><div class="title"><div data-togglable="Parameters"><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><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code>.</p></div></div></div></div></div></div></div></div></div></div></div>
</div> </div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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 class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>

2
docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/create.html
View file

@ -28,7 +28,7 @@
<div> <div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="create.html">create</a>(domain: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, title: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, group_guid: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, tags: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyArray(), deeplinks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt;&gt; = emptyArray(), long_url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="create.html">create</a>(domain: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, title: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, group_guid: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, tags: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyArray(), deeplinks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt;&gt; = emptyArray(), long_url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div>
</div> </div>
<p class="paragraph">Converts a long url to a Bitlink and sets additional parameters.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#createFullBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph">The shorten URL or JSON response, or on error, an empty string/JSON object.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code></p></div></div></div></div></div></div></div></div></div></div></div> <p class="paragraph">Converts a long url to a Bitlink and sets additional parameters.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#createFullBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph">The shorten URL or an empty string on error.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">long_url</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The long URL.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code>.</p></div></div></div></div></div></div></div></div></div></div></div>
</div> </div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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 class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>

2
docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/expand.html
View file

@ -28,7 +28,7 @@
<div> <div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="expand.html">expand</a>(bitlink_id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="expand.html">expand</a>(bitlink_id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div>
</div> </div>
<p class="paragraph">Expands a Bitlink.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#expandBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph">The long URL or JSON response, or on error, an empty string/JSON object.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">bitlink_id</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The bitlink ID.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code></p></div></div></div></div></div></div></div></div></div></div></div> <p class="paragraph">Expands a Bitlink.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#expandBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph">The long URL or an empty string on error.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">bitlink_id</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The bitlink ID.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code>.</p></div></div></div></div></div></div></div></div></div></div></div>
</div> </div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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 class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>

2
docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html
View file

@ -28,7 +28,7 @@
<div> <div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="shorten.html">shorten</a>(long_url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, group_guid: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, domain: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="shorten.html">shorten</a>(long_url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, group_guid: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, domain: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div>
</div> </div>
<p class="paragraph">Shortens a long URL.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#createBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph">The short URL or JSON response, or on error, the <a href="shorten.html">long_url</a> or an empty JSON object.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">long_url</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The long URL.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code></p></div></div></div></div></div></div></div></div></div></div></div> <p class="paragraph">Shortens a long URL.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#createBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph">The short URL or the <a href="shorten.html">long_url</a> on error.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">long_url</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The long URL.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code>.</p></div></div></div></div></div></div></div></div></div></div></div>
</div> </div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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 class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>

2
docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/update.html
View file

@ -28,7 +28,7 @@
<div> <div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="update.html">update</a>(bitlink: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, references: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyMap(), archived: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, tags: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyArray(), created_at: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, title: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, deeplinks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt;&gt; = emptyArray(), created_by: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, long_url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, client_id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, custom_bitlinks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyArray(), link: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-synchronized/index.html">Synchronized</a>()</div><div class="block">@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="update.html">update</a>(bitlink: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, references: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyMap(), archived: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, tags: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyArray(), created_at: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, title: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, deeplinks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt;&gt; = emptyArray(), created_by: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, long_url: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, client_id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, custom_bitlinks: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>&gt; = emptyArray(), link: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, id: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.EMPTY, toJson: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><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></div>
</div> </div>
<p class="paragraph">Updates fields in the specified Bitlink.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#updateBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph"><code>true</code> is the update was successful, <code>false</code> otherwise, or JSON response.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code></p></div></div></div></div></div></div></div></div></div></div></div> <p class="paragraph">Updates fields in the specified Bitlink.</p><p class="paragraph">See the <a href="https://dev.bitly.com/api-reference#updateBitlink">Bit.ly API</a> for more information.</p><h4 class="">Return</h4><p class="paragraph"><a href="../-constants/-constants/-t-r-u-e.html">Constants.TRUE</a> if the update was successful, <a href="../-constants/-constants/-f-a-l-s-e.html">Constants.FALSE</a> otherwise.</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">bitlink</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A Bitlink made of the domain and hash.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">toJson</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Returns the full JSON response if <code>true</code>.</p></div></div></div></div></div></div></div></div></div></div></div>
</div> </div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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 class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>

24
src/main/kotlin/net/thauvin/erik/bitly/Bitlinks.kt
View file

@ -62,8 +62,8 @@ open class Bitlinks(private val accessToken: String) {
* @param size The quantity of items to be be returned. * @param size The quantity of items to be be returned.
* @param unit_reference An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. * @param unit_reference An ISO-8601 timestamp, indicating the most recent time for which to pull metrics.
* Will default to current time. * Will default to current time.
* @param toJson Returns the full JSON response if `true` * @param toJson Returns the full JSON response if `true`.
* @return The click counts or JSON response object. * @return The click counts.
*/ */
@Synchronized @Synchronized
@JvmOverloads @JvmOverloads
@ -98,9 +98,9 @@ open class Bitlinks(private val accessToken: String) {
* *
* See the [Bit.ly API](https://dev.bitly.com/api-reference#createFullBitlink) for more information. * See the [Bit.ly API](https://dev.bitly.com/api-reference#createFullBitlink) for more information.
* *
* @oaran long_url The long URL. * @param long_url The long URL.
* @param toJson Returns the full JSON response if `true` * @param toJson Returns the full JSON response if `true`.
* @return The shorten URL or JSON response, or on error, an empty string/JSON object. * @return The shorten URL or an empty string on error.
*/ */
@Synchronized @Synchronized
@JvmOverloads @JvmOverloads
@ -138,8 +138,8 @@ open class Bitlinks(private val accessToken: String) {
* See the [Bit.ly API](https://dev.bitly.com/api-reference#expandBitlink) for more information. * See the [Bit.ly API](https://dev.bitly.com/api-reference#expandBitlink) for more information.
* *
* @param bitlink_id The bitlink ID. * @param bitlink_id The bitlink ID.
* @param toJson Returns the full JSON response if `true` * @param toJson Returns the full JSON response if `true`.
* @return The long URL or JSON response, or on error, an empty string/JSON object. * @return The long URL or an empty string on error.
*/ */
@Synchronized @Synchronized
@JvmOverloads @JvmOverloads
@ -187,8 +187,8 @@ open class Bitlinks(private val accessToken: String) {
* See the [Bit.ly API](https://dev.bitly.com/api-reference#createBitlink) for more information. * See the [Bit.ly API](https://dev.bitly.com/api-reference#createBitlink) for more information.
* *
* @param long_url The long URL. * @param long_url The long URL.
* @param toJson Returns the full JSON response if `true` * @param toJson Returns the full JSON response if `true`.
* @return The short URL or JSON response, or on error, the [long_url] or an empty JSON object. * @return The short URL or the [long_url] on error.
*/ */
@Synchronized @Synchronized
@JvmOverloads @JvmOverloads
@ -221,9 +221,9 @@ open class Bitlinks(private val accessToken: String) {
* *
* See the [Bit.ly API](https://dev.bitly.com/api-reference#updateBitlink) for more information. * See the [Bit.ly API](https://dev.bitly.com/api-reference#updateBitlink) for more information.
* *
* @oaran bitlink A Bitlink made of the domain and hash. * @param bitlink A Bitlink made of the domain and hash.
* @param toJson Returns the full JSON response if `true` * @param toJson Returns the full JSON response if `true`.
* @return `true` is the update was successful, `false` otherwise, or JSON response. * @return [Constants.TRUE] if the update was successful, [Constants.FALSE] otherwise.
*/ */
@Synchronized @Synchronized
@JvmOverloads @JvmOverloads

5
src/test/kotlin/net/thauvin/erik/bitly/BitlyTest.kt
View file

@ -84,6 +84,11 @@ class BitlyTest {
assertEquals(Constants.EMPTY, bitly.bitlinks().shorten(Constants.EMPTY)) assertEquals(Constants.EMPTY, bitly.bitlinks().shorten(Constants.EMPTY))
} }
@Test
fun `long url should not be short`() {
assertEquals(shortUrl, bitly.bitlinks().shorten(shortUrl))
}
@Test @Test
fun `shorten = expand`() { fun `shorten = expand`() {
val shortUrl = bitly.bitlinks().shorten(longUrl, domain = "bit.ly") val shortUrl = bitly.bitlinks().shorten(longUrl, domain = "bit.ly")