Bitlinks
-Sources
-clicks
-clicks
Returns the click counts for a specified Bitlink.
See the Bitly API for more information.
Return
The click counts.
Parameters
A Bitlink made of the domain and hash.
A unit of time.
An integer representing the time units to query data for. Pass -1 to return all units available.
The quantity of items to be be returned.
An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Returns the full JSON response if true
.
Sources
-Returns the click counts for a specified Bitlink.
See the Bitly API for more information.
Return
The click counts.
Parameters
A Bitlink made of the domain and hash.
A unit of time.
An integer representing the time units to query data for. Pass -1 to return all units available.
The quantity of items to be be returned.
An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Returns the full JSON response if true
.
Sources
+ +create
-create
Converts a long url to a Bitlink and sets additional parameters.
See the Bit.ly API for more information.
Return
The shorten URL or an empty string on error.
Parameters
A branded short domain or bit.ly
by default.
A GUID for a Bitly group.
The long URL.
Returns the full JSON response if true
.
Sources
-Converts a long url to a Bitlink and sets additional parameters.
See the Bit.ly API for more information.
Return
The shorten URL or an empty string on error.
Parameters
A branded short domain or bit.ly
by default.
A GUID for a Bitly group.
The long URL.
Returns the full JSON response if true
.
Sources
+ +expand
-expand
Expands a Bitlink.
See the Bit.ly API for more information.
Return
The long URL or an empty string on error.
Parameters
The bitlink ID.
Returns the full JSON response if true
.
Sources
-Expands a Bitlink.
See the Bit.ly API for more information.
Return
The long URL or an empty string on error.
Parameters
The bitlink ID.
Returns the full JSON response if true
.
Sources
+ +Bitlinks
- -Constructors
- -Functions
-Converts a long url to a Bitlink and sets additional parameters.
Updates fields in the specified Bitlink.
Properties
-Sources
-Constructors
+ +Functions
+Converts a long url to a Bitlink and sets additional parameters.
Updates fields in the specified Bitlink.
Properties
+ +Sources
+last Call Response
- last Call Response
The last API call response.
Sources
-The last API call response.
Sources
+ +shorten
-shorten
Shortens a long URL.
See the Bit.ly API for more information.
Return
The short URL or the long_url on error.
Parameters
The long URL.
A GUID for a Bitly group.
A branded short domain or bit.ly
by default.
Returns the full JSON response if true
.
Sources
-Shortens a long URL.
See the Bit.ly API for more information.
Return
The short URL or the long_url on error.
Parameters
The long URL.
A GUID for a Bitly group.
A branded short domain or bit.ly
by default.
Returns the full JSON response if true
.
Sources
+ +update
-update
Updates fields in the specified Bitlink.
See the Bit.ly API for more information.
Return
Constants.TRUE if the update was successful, Constants.FALSE otherwise.
Parameters
A Bitlink made of the domain and hash.
Returns the full JSON response if true
.
Sources
-Updates fields in the specified Bitlink.
See the Bit.ly API for more information.
Return
Constants.TRUE if the update was successful, Constants.FALSE otherwise.
Parameters
A Bitlink made of the domain and hash.
Returns the full JSON response if true
.
Sources
+ +Bitly
-Bitly
Creates a new instance using an API Access Token.
Parameters
The API access token.
Creates a new instance using a properties and property key.
Parameters
The properties containing the API Access Token.
The property key containing the API Access Token.
Creates a new instance using a properties file path and property key.
Parameters
The file path of the properties containing the API Access Token.
The property key containing the API Access Token.
Creates a new instance using a properties file and property key.
Parameters
The properties file containing the API Access Token.
The property key containing the API Access Token.
Creates new instance.
Creates a new instance using an API Access Token.
Parameters
The API access token.
Creates a new instance using a properties and property key.
Parameters
The properties containing the API Access Token.
The property key containing the API Access Token.
Creates a new instance using a properties file path and property key.
Parameters
The file path of the properties containing the API Access Token.
The property key containing the API Access Token.
Creates a new instance using a properties file and property key.
Parameters
The properties file containing the API Access Token.
The property key containing the API Access Token.
Creates new instance.
Sources
+ +access Token
- Sources
-The API access token.
See Generic Access Token or Authentication.
Sources
+ +bitlinks
-bitlinks
Returns a new Bitlinks instance.
Sources
-Sources
+ +call
-call
Executes an API call.
Return
A CallResponse object.
Parameters
The REST endpoint. (eg. https://api-ssl.bitly.com/v4/shorten
)
The request parameters key/value map.
The submission Method.
Sources
-Executes an API call.
Return
A CallResponse object.
Parameters
The REST endpoint. (eg. https://api-ssl.bitly.com/v4/shorten
)
The request parameters key/value map.
The submission Method.
Sources
+ +Bitly
-Provides access to the Bitly API v4.
Constructors
-Creates a new instance using a properties and property key.
Functions
-Bitly
+Provides access to the Bitly API v4.
Returns a new Bitlinks instance.
Properties
-Sources
-Constructors
+Creates a new instance using a properties and property key.
Functions
+Properties
+ +Sources
+Call Response
- Sources
-Call Response
+ Sources
+ +body
-Sources
-Call Response
- Provides a data class to hold the JSON response.
Constructors
-Properties
-Sources
-Call Response
+ Provides a data class to hold the JSON response.
Constructors
+Properties
+Sources
+is Bad Request
- Sources
-is Created
- Sources
-is Expectation Failed
- Sources
-is Forbidden
- Sources
-is Internal Error
- Sources
-is Not Found
- Sources
-is Successful
- Sources
-is Temporarily Unavailable
- Sources
-is Unprocessable Entity
- Sources
-is Upgrade Required
- Sources
-result Code
- Sources
-API_BASE_URL
-API_BASE_URL
The Bitly API base URL.
Sources
-The Bitly API base URL.
Sources
+ +EMPTY_JSON
-EMPTY_JSON
Empty JSON Object.
Sources
-Empty JSON Object.
Sources
+ +ENV_ACCESS_TOKEN
-ENV_ACCESS_TOKEN
The API access token environment variable.
Sources
-The API access token environment variable.
Sources
+ +Constants
-Properties
-Sources
-Constants
-Provides the constants for this package.
Types
-Sources
-DELETE
-GET
-PATCH
-POST
-Methods
- -Entries
- -Properties
- -Sources
-DAY
-HOUR
-MINUTE
-MONTH
-WEEK
-Entries
- -Properties
- -Sources
-call
-call
Executes an API call.
Return
A CallResponse object.
Parameters
The API access token.
The REST endpoint. (eg. https://api-ssl.bitly.com/v4/shorten
)
The request parameters key/value map.
The submission Method.
Sources
-Executes an API call.
Return
A CallResponse object.
Parameters
The API access token.
The REST endpoint. (eg. https://api-ssl.bitly.com/v4/shorten
)
The request parameters key/value map.
The submission Method.
Sources
+ +Companion
-Functions
-Is Level.SEVERE logging enabled.
Validates a URL.
Removes http(s) scheme from string.
Builds the full API endpoint URL using the Constants.API_BASE_URL.
Properties
- -Sources
-Functions
+Is Level.SEVERE logging enabled.
Validates a URL.
Removes http(s) scheme from string.
Builds the full API endpoint URL using the Constants.API_BASE_URL.
Properties
+ +Sources
+is Severe Loggable
- is Severe Loggable
Is Level.SEVERE logging enabled.
Sources
-Is Level.SEVERE logging enabled.
Sources
+ +is Valid Url
- is Valid Url
Validates a URL.
Sources
-Validates a URL.
Sources
+ +logger
-logger
The logger instance.
Sources
-Sources
+ +remove Http
- remove Http
Removes http(s) scheme from string.
Sources
-Removes http(s) scheme from string.
Sources
+ +to End Point
- to End Point
Builds the full API endpoint URL using the Constants.API_BASE_URL.
Sources
-Builds the full API endpoint URL using the Constants.API_BASE_URL.
Sources
+ +Utils
-Provides useful generic functions.
Types
-Sources
-Package net. thauvin. erik. bitly
- Provides the classes necessary to access the Bitly API v4.
Types
-Package net. thauvin. erik. bitly
+ Provides the classes necessary to access the Bitly API v4.
Provides functions to create and manage Bitlinks.
Provides access to the Bitly API v4.
Provides a data class to hold the JSON response.
Types
+Provides access to the Bitly API v4.
Provides a data class to hold the JSON response.
bitly-shorten
-Bitly Shortener for Kotlin/Java
A simple implementation of the link shortening (Bitlinks) abilities of the Bitly API v4.
Packages
-Provides the classes necessary to access the Bitly API v4.
-bitly-shorten
+Bitly Shortener for Kotlin/Java
A simple implementation of the link shortening (Bitlinks) abilities of the Bitly API v4.
Packages
+Provides the classes necessary to access the Bitly API v4.
+