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

Added docs.

Browse source
This commit is contained in:
Erik C. Thauvin 2020-03-02 20:33:22 -08:00
parent 597b5516e1
commit 166ca8af06
51 changed files with 1725 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

64
docs/bitly-shorten/net.thauvin.erik.bitly/-utils/index.html Normal file
View file

@ -0,0 +1,64 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Utils - bitly-shorten</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">bitly-shorten</a>&nbsp;/&nbsp;<a href="../index.html">net.thauvin.erik.bitly</a>&nbsp;/&nbsp;<a href="./index.html">Utils</a><br/>
<br/>
<h1>Utils</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Utils</span></code> <a href="https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/Utils.kt#L50">(source)</a>
<p>Useful functions.</p>
<h3>Companion Object Properties</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="logger.html">logger</a></h4>
</td>
<td>
<p>The logger instance.</p>
<code><span class="keyword">val </span><span class="identifier">logger</span><span class="symbol">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html"><span class="identifier">Logger</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Companion Object Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="call.html">call</a></h4>
</td>
<td>
<p>Executes an API call.</p>
<code><span class="keyword">fun </span><span class="identifier">call</span><span class="symbol">(</span><span class="identifier" id="net.thauvin.erik.bitly.Utils.Companion$call(kotlin.String, kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)), net.thauvin.erik.bitly.Methods)/accessToken">accessToken</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Utils.Companion$call(kotlin.String, kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)), net.thauvin.erik.bitly.Methods)/endPoint">endPoint</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Utils.Companion$call(kotlin.String, kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)), net.thauvin.erik.bitly.Methods)/params">params</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">,</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span>&nbsp;<span class="symbol">=</span>&nbsp;emptyMap()<span class="symbol">, </span><span class="identifier" id="net.thauvin.erik.bitly.Utils.Companion$call(kotlin.String, kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)), net.thauvin.erik.bitly.Methods)/method">method</span><span class="symbol">:</span>&nbsp;<a href="../-methods/index.html"><span class="identifier">Methods</span></a>&nbsp;<span class="symbol">=</span>&nbsp;Methods.POST<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="is-valid-url.html">isValidUrl</a></h4>
</td>
<td>
<p>Validates a URL.</p>
<code><span class="keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">.</span><span class="identifier">isValidUrl</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="remove-http.html">removeHttp</a></h4>
</td>
<td>
<p>Removes http(s) scheme from string.</p>
<code><span class="keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">.</span><span class="identifier">removeHttp</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="to-end-point.html">toEndPoint</a></h4>
</td>
<td>
<p>Builds the full API endpoint URL using the <a href="../-constants/-a-p-i_-b-a-s-e_-u-r-l.html">Constants.API_BASE_URL</a>.</p>
<code><span class="keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">.</span><span class="identifier">toEndPoint</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>