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/shorten.html
View file

@ -28,7 +28,7 @@
<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>
<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 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>