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

Updated to new API documention URL.

Browse source
This commit is contained in:
Erik C. Thauvin 2020-09-13 16:27:21 -07:00
parent 720986b83f
commit 2c8a9c61cc
4 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -4,7 +4,7 @@
# [Bitly](https://dev.bitly.com/v4/) Shortener for Kotlin/Java/Android
A simple implementation of the link shortening ([bitlinks](https://dev.bitly.com/v4/#tag/Bitlinks)) abilities of the [Bitly v4 API](https://dev.bitly.com/v4).
A simple implementation of the link shortening (Bitlinks) abilities of the [Bitly v4 API](https://dev.bitly.com/api-reference).
## Examples (TL;DR)

4
config/dokka/packages.md
View file

@ -2,8 +2,8 @@
[Bitly Shortener for Kotlin/Java](https://github.com/ethauvin/bitly-shorten)
A simple implementation of the link shortening ([bitlinks](https://dev.bitly.com/v4/#tag/Bitlinks)) abilities of the [Bitly API v4](https://dev.bitly.com/v4).
A simple implementation of the link shortening (Bitlinks) abilities of the [Bitly API v4](https://dev.bitly.com/api-reference).
# Package net.thauvin.erik.bitly
Provides the classes necessary to access the [Bitly API v4](https://dev.bitly.com/v4).
Provides the classes necessary to access the [Bitly API v4](https://dev.bitly.com/api-reference).

16
src/main/kotlin/net/thauvin/erik/bitly/Bitlinks.kt
View file

@ -40,9 +40,9 @@ import org.json.JSONObject
import java.util.logging.Level
/**
* Provides functions to create and manage [Bitlinks](https://dev.bitly.com/v4/#tag/Bitlinks).
* Provides functions to create and manage Bitlinks.
*
* See the [Bitly API](https://dev.bitly.com/v4/#tag/Bitlinks) for more information.
* See the [Bitly API](https://dev.bitly.com/api-reference) for more information.
*/
open class Bitlinks(private val accessToken: String) {
/**
@ -54,7 +54,7 @@ open class Bitlinks(private val accessToken: String) {
/**
* Returns the click counts for a specified Bitlink.
*
* See the [Bitly API](https://dev.bitly.com/v4/#operation/getClicksSummaryForBitlink) for more information.
* See the [Bitly API](https://dev.bitly.com/api-reference#getClicksSummaryForBitlink) for more information.
*
* @param bitlink A Bitlink made of the domain and hash.
* @param unit A [unit of time][Units].
@ -96,7 +96,7 @@ open class Bitlinks(private val accessToken: String) {
/**
* Converts a long url to a Bitlink and sets additional parameters.
*
* See the [Bit.ly API](https://dev.bitly.com/v4/#operation/createFullBitlink) for more information.
* See the [Bit.ly API](https://dev.bitly.com/api-reference#createFullBitlink) for more information.
*
* @oaran long_url The long URL.
* @param toJson Returns the full JSON response if `true`
@ -135,7 +135,7 @@ open class Bitlinks(private val accessToken: String) {
/**
* Expands a Bitlink.
*
* See the [Bit.ly API](https://dev.bitly.com/v4/#operation/expandBitlink) for more information.
* See the [Bit.ly API](https://dev.bitly.com/api-reference#expandBitlink) for more information.
*
* @param bitlink_id The bitlink ID.
* @param toJson Returns the full JSON response if `true`
@ -184,7 +184,7 @@ open class Bitlinks(private val accessToken: String) {
/**
* Shortens a long URL.
*
* See the [Bit.ly API](https://dev.bitly.com/v4/#operation/createBitlink) for more information.
* See the [Bit.ly API](https://dev.bitly.com/api-reference#createBitlink) for more information.
*
* @param long_url The long URL.
* @param toJson Returns the full JSON response if `true`
@ -220,9 +220,9 @@ open class Bitlinks(private val accessToken: String) {
}
/**
* Updates fields in the Bitlink.
* Updates fields in the specified Bitlink.
*
* See the [Bit.ly API](https://dev.bitly.com/v4/#operation/updateBitlink) for more information.
* See the [Bit.ly API](https://dev.bitly.com/api-reference#updateBitlink) for more information.
*
* @oaran bitlink A Bitlink made of the domain and hash.
* @param toJson Returns the full JSON response if `true`

4
src/main/kotlin/net/thauvin/erik/bitly/Bitly.kt
View file

@ -38,7 +38,7 @@ import java.nio.file.Path
import java.util.Properties
/**
* Provides access to the [Bitly API v4](https://dev.bitly.com/v4).
* Provides access to the [Bitly API v4](https://dev.bitly.com/api-reference).
*
* @constructor Creates new instance.
*/
@ -46,7 +46,7 @@ open class Bitly() {
/** The API access token.
*
* See [Generic Access Token](https://bitly.is/accesstoken) or
* [Authentication](https://dev.bitly.com/v4/#section/Authentication).
* [Authentication](https://dev.bitly.com/docs/getting-started/authentication).
**/
var accessToken: String = System.getenv(Constants.ENV_ACCESS_TOKEN)
?: (System.getProperty(Constants.ENV_ACCESS_TOKEN) ?: Constants.EMPTY)