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>
|
||||
|
|
@ -82,7 +82,7 @@
|
|||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a></div><div class="brief "><p class="paragraph">The logger instance.</p></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">val </span><a href="logger.html">logger</a><span class="token operator">: </span><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a></div><div class="brief "><p class="paragraph">The logger instance.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -101,13 +101,13 @@
|
|||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="call.html"><span class="token function">call</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">accessToken<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 ">endPoint<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 ">params<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter ">method<span class="token operator">: </span><a href="../-methods/index.html">Methods</a><span class="token operator"> = </span>Methods.POST</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-call-response/index.html">CallResponse</a></div><div class="brief "><p class="paragraph">Executes an API call.</p></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="call.html"><span class="token function">call</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">accessToken<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 ">endPoint<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 ">params<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token operator"> = </span>emptyMap()<span class="token punctuation">, </span></span><span class="parameter ">method<span class="token operator">: </span><a href="../-methods/index.html">Methods</a><span class="token operator"> = </span>Methods.POST</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-call-response/index.html">CallResponse</a></div><div class="brief "><p class="paragraph">Executes an API call.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1166428795%2FFunctions%2F-1617659094" anchor-label="isSevereLoggable" id="1166428795%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current="root/main" data-filterable-set="root/main">
|
||||
<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><a href="is-severe-loggable.html"><span>is</span><wbr></wbr><span>Severe</span><wbr></wbr><span><span>Loggable</span></span></a></div>
|
||||
|
|
@ -116,13 +116,13 @@
|
|||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a><span class="token punctuation">.</span><a href="is-severe-loggable.html"><span class="token function">isSevereLoggable</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Determines if <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#SEVERE()">Level.SEVERE</a> logging is enabled.</p></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="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Logger.html">Logger</a><span class="token punctuation">.</span><a href="is-severe-loggable.html"><span class="token function">isSevereLoggable</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Determines if <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html#SEVERE()">Level.SEVERE</a> logging is enabled.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-776238816%2FFunctions%2F-1617659094" anchor-label="isValidUrl" id="-776238816%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current="root/main" data-filterable-set="root/main">
|
||||
<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><a href="is-valid-url.html"><span>is</span><wbr></wbr><span>Valid</span><wbr></wbr><span><span>Url</span></span></a></div>
|
||||
|
|
@ -131,13 +131,13 @@
|
|||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="is-valid-url.html"><span class="token function">isValidUrl</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Validates a URL.</p></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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="is-valid-url.html"><span class="token function">isValidUrl</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Validates a URL.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1635842577%2FFunctions%2F-1617659094" anchor-label="removeHttp" id="-1635842577%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current="root/main" data-filterable-set="root/main">
|
||||
<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><a href="remove-http.html"><span>remove</span><wbr></wbr><span><span>Http</span></span></a></div>
|
||||
|
|
@ -146,13 +146,13 @@
|
|||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="remove-http.html"><span class="token function">removeHttp</span></a><span class="token punctuation">(</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></div><div class="brief "><p class="paragraph">Removes http(s) scheme from string.</p></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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="remove-http.html"><span class="token function">removeHttp</span></a><span class="token punctuation">(</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></div><div class="brief "><p class="paragraph">Removes http(s) scheme from string.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1083777837%2FFunctions%2F-1617659094" anchor-label="toEndPoint" id="-1083777837%2FFunctions%2F-1617659094" data-filterable-set="root/main"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current="root/main" data-filterable-set="root/main">
|
||||
<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><a href="to-end-point.html"><span>to</span><wbr></wbr><span>End</span><wbr></wbr><span><span>Point</span></span></a></div>
|
||||
|
|
@ -161,7 +161,7 @@
|
|||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="to-end-point.html"><span class="token function">toEndPoint</span></a><span class="token punctuation">(</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></div><div class="brief "><p class="paragraph">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></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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="to-end-point.html"><span class="token function">toEndPoint</span></a><span class="token punctuation">(</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></div><div class="brief "><p class="paragraph">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></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -172,7 +172,7 @@
|
|||
</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