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

Updated docs and examples

Browse source
This commit is contained in:
Erik C. Thauvin 2024-05-22 21:10:34 -07:00
parent a8855096b3
commit 4900d5a342
Signed by: erik
GPG key ID: 776702A6A2DA330E
148 changed files with 5414 additions and 728 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -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>
@ -66,10 +66,10 @@
<div class="cover ">
<h1 class="cover"><span><span>shorten</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="shorten.html"><span class="token function">shorten</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">long_url<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 ">group_guid<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 ">domain<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#L221">source</a>)</span></span></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><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The short URL or the <a href="shorten.html">long_url</a> on error.</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>long_url</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The long URL.</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>group_guid</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A GUID for a Bitly group.</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>domain</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A branded short domain or <code class="lang-kotlin">bit.ly</code> by default.</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="shorten.html"><span class="token function">shorten</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">long_url<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 ">domain<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 ">group_guid<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#L224">source</a>)</span></span></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><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The short URL or the <a href="shorten.html">long_url</a> on error.</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>long_url</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The long URL.</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>domain</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A branded short domain or <code class="lang-kotlin">bit.ly</code> by default.</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>group_guid</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A GUID for a Bitly group.</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>