bitly-shorten/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/index.html
2021-03-21 12:47:09 -07:00

156 lines
23 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Bitly</title>
<link href="../../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../../scripts/main.js" async="async"></script> </head>
<body>
<div id="container">
<div id="leftColumn"><a href="../../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="bitly-shorten::net.thauvin.erik.bitly/Bitly///PointingToDeclaration//-251103770">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../../index.html">bitly-shorten</a>/<a href="../index.html">net.thauvin.erik.bitly</a>/<a href="index.html">Bitly</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Bitly</span></h1>
<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">open class <a href="index.html">Bitly</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><p class="paragraph">Provides access to the <a href="https://dev.bitly.com/api-reference">Bitly API v4</a>.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" anchor-label="Bitly" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-bitly.html">Bitly</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">fun <a href="-bitly.html">Bitly</a>(accessToken: <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 class="brief ">Creates a new instance using an <a href="access-token.html">API Access Token</a>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.util.Properties%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" anchor-label="Bitly" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.util.Properties%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-bitly.html">Bitly</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.util.Properties%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="-bitly.html">Bitly</a>(properties: <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html">Properties</a>, key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.ENV_ACCESS_TOKEN)<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 class="brief ">Creates a new instance using a <span data-unresolved-link="net.thauvin.erik.bitly/Bitly/&amp;lt;init&amp;gt;/#java.util.Properties#kotlin.String/PointingToCallableParameters(0)/">Properties</span> and <span data-unresolved-link="net.thauvin.erik.bitly/Bitly/&amp;lt;init&amp;gt;/#java.util.Properties#kotlin.String/PointingToCallableParameters(1)/">Property Key</span>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.nio.file.Path%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" anchor-label="Bitly" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.nio.file.Path%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-bitly.html">Bitly</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.nio.file.Path%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="-bitly.html">Bitly</a>(propertiesFilePath: <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html">Path</a>, key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.ENV_ACCESS_TOKEN)<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 class="brief ">Creates a new instance using a <span data-unresolved-link="net.thauvin.erik.bitly/Bitly/&amp;lt;init&amp;gt;/#java.nio.file.Path#kotlin.String/PointingToCallableParameters(0)/">Properties File Path</span> and <span data-unresolved-link="net.thauvin.erik.bitly/Bitly/&amp;lt;init&amp;gt;/#java.nio.file.Path#kotlin.String/PointingToCallableParameters(1)/">Property Key</span>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.io.File%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" anchor-label="Bitly" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.io.File%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-bitly.html">Bitly</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23java.io.File%23kotlin.String%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="-bitly.html">Bitly</a>(propertiesFile: <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a>, key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a> = Constants.ENV_ACCESS_TOKEN)<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 class="brief ">Creates a new instance using a <span data-unresolved-link="net.thauvin.erik.bitly/Bitly/&amp;lt;init&amp;gt;/#java.io.File#kotlin.String/PointingToCallableParameters(0)/">Properties File</span> and <span data-unresolved-link="net.thauvin.erik.bitly/Bitly/&amp;lt;init&amp;gt;/#java.io.File#kotlin.String/PointingToCallableParameters(1)/">Property Key</span>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" anchor-label="Bitly" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-bitly.html">Bitly</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2FBitly%2F%23%2FPointingToDeclaration%2F%5D%2FConstructors%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">fun <a href="-bitly.html">Bitly</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 class="brief ">Creates new instance.</div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" anchor-label="bitlinks" id="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="bitlinks.html">bitlinks</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></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">fun <a href="bitlinks.html">bitlinks</a>(): <a href="../-bitlinks/index.html">Bitlinks</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>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" anchor-label="bitlinks" id="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" anchor-label="bitlinks" id="%5Bnet.thauvin.erik.bitly%2FBitly%2Fbitlinks%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>Returns a new <a href="../-bitlinks/index.html">Bitlinks</a> instance.</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" anchor-label="call" id="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="call.html">call</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></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/-jvm-overloads/index.html">JvmOverloads</a>()</div></div>fun <a href="call.html">call</a>(endPoint: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, params: <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/-any/index.html">Any</a>&gt; = emptyMap(), method: <a href="../-methods/index.html">Methods</a> = Methods.POST): <a href="../-call-response/index.html">CallResponse</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>
<a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" anchor-label="call" id="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" anchor-label="call" id="%5Bnet.thauvin.erik.bitly%2FBitly%2Fcall%2F%23kotlin.String%23kotlin.collections.Map%5Bkotlin.String%2Ckotlin.Any%5D%23net.thauvin.erik.bitly.Methods%2FPointingToDeclaration%2F%5D%2FFunctions%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>Executes an API call.</div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770" anchor-label="accessToken" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="access-token.html">accessToken</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770" anchor-label="accessToken" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">var <a href="access-token.html">accessToken</a>: <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 class="brief "><a data-name="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770" anchor-label="accessToken" id="%5Bnet.thauvin.erik.bitly%2FBitly%2FaccessToken%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-251103770" data-filterable-set=":dokkaHtml/main"></a>The API access token.</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>
</div>
</body>
</html>