diff --git a/.circleci/config.yml b/.circleci/config.yml index 7bf833e..c781fdc 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,55 +1,62 @@ -version: 2 +version: 2.1 + +orbs: + sdkman: joshdholtz/sdkman@0.2.0 + defaults: &defaults working_directory: ~/repo environment: JVM_OPTS: -Xmx3200m TERM: dumb - CI: true + CI_NAME: "CircleCI" -defaults_gradle: &defaults_gradle - steps: - - checkout - - restore_cache: - keys: - - gradle-dependencies-{{ checksum "build.gradle.kts" }} - # fallback to using the latest cache if no exact match is found - - gradle-dependencies- - - run: - name: Gradle Dependencies - command: ./gradlew dependencies - - save_cache: - paths: ~/.m2 - key: gradle-dependencies-{{ checksum "build.gradle.kts" }} - - run: - name: Run All Checks - command: ./gradlew check - - store_artifacts: - path: build/reports/ - destination: reports - - store_test_results: - path: build/reports/ +commands: + build_and_test: + parameters: + reports-dir: + type: string + default: "build/reports/test_results" + steps: + - checkout + - sdkman/setup-sdkman + - sdkman/sdkman-install: + candidate: kotlin + version: 2.1.10 + - run: + name: Download dependencies + command: ./bld download + - run: + name: Compile source + command: ./bld compile + - run: + name: Run tests + command: ./bld jacoco -reports-dir=<< parameters.reports-dir >> + - store_test_results: + path: << parameters.reports-dir >> + - store_artifacts: + path: build/reports/jacoco/test/html jobs: - build_gradle_jdk14: + bld_jdk17: <<: *defaults docker: - - image: openjdk:14-jdk + - image: cimg/openjdk:17.0 - <<: *defaults_gradle + steps: + - build_and_test - build_gradle_jdk8: + bld_jdk21: <<: *defaults docker: - - image: circleci/openjdk:8-jdk + - image: cimg/openjdk:21.0 - <<: *defaults_gradle + steps: + - build_and_test workflows: - version: 2 - gradle: - jobs: - - build_gradle_jdk8 - - build_gradle_jdk14 - + bld: + jobs: + - bld_jdk17 + - bld_jdk21 diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml new file mode 100644 index 0000000..4ee117f --- /dev/null +++ b/.github/workflows/bld.yml @@ -0,0 +1,72 @@ +name: bld-ci + +on: [ push, pull_request, workflow_dispatch ] + +env: + BITLY_ACCESS_TOKEN: ${{ secrets.BITLY_ACCESS_TOKEN }} + COVERAGE_JDK: "21" + COVERAGE_KOTLIN: "2.0.21" + +jobs: + build-bld-project: + strategy: + matrix: + java-version: [ 17, 21, 24 ] + kotlin-version: [ 1.9.25, 2.0.21, 2.1.20 ] + os: [ ubuntu-latest, windows-latest, macos-latest ] + + runs-on: ${{ matrix.os }} + + steps: + - name: Checkout source repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Set up JDK ${{ matrix.java-version }} with Kotlin ${{ matrix.kotlin-version }} + uses: actions/setup-java@v4 + with: + distribution: "zulu" + java-version: ${{ matrix.java-version }} + + - name: Download dependencies [bld example] + working-directory: examples/bld + run: ./bld download + + - name: Compile and run examples [bld examples] + working-directory: examples/bld + run: | + ./bld compile + ./bld run --args='https://erik.thauvin.net/ https://bit.ly/2PsNMAA' + ./bld run-retrieve + ./bld run-java --args='https://erik.thauvin.net/ https://bit.ly/2PsNMAA' + + - name: Run examples [gradle examples] + working-directory: examples/gradle + if: matrix.java-version != '24' + run: | + ./gradlew run --args='https://erik.thauvin.net/ https://bit.ly/2PsNMAA' + ./gradlew runRetrieve + ./gradlew runJava --args='https://erik.thauvin.net/ https://bit.ly/2PsNMAA' + + - name: Download dependencies + run: ./bld download + + - name: Compile source + run: ./bld compile + + - name: Run tests + run: ./bld jacoco + + - name: Remove pom.xml + if: success() && matrix.java-version == env.COVERAGE_JDK && matrix.kotlin-version == env.COVERAGE_KOTLIN + && matrix.os == 'ubuntu-latest' + run: rm -rf pom.xml + + - name: SonarCloud Scan + uses: sonarsource/sonarcloud-github-action@master + if: success() && matrix.java-version == env.COVERAGE_JDK && matrix.kotlin-version == env.COVERAGE_KOTLIN + && matrix.os == 'ubuntu-latest' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml deleted file mode 100644 index 0ee725c..0000000 --- a/.github/workflows/gradle.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Java CI with Gradle - -on: [push, pull_request, workflow_dispatch] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up JDK 1.8 - uses: actions/setup-java@v1 - with: - java-version: 1.8 - - name: Grant execute permission for gradlew - run: chmod +x gradlew - - name: Test with Gradle - run: ./gradlew check - env: - BITLY_ACCESS_TOKEN: ${{ secrets.BITLY_ACCESS_TOKEN }} diff --git a/.github_changelog_generator b/.github_changelog_generator index 7d2b4bb..a12ba88 100644 --- a/.github_changelog_generator +++ b/.github_changelog_generator @@ -1 +1 @@ -future-release=0.9.3 +future-release=1.0.0 diff --git a/.gitignore b/.gitignore index a602396..1808834 100644 --- a/.gitignore +++ b/.gitignore @@ -1,84 +1,61 @@ -!.vscode/extensions.json -!.vscode/launch.json -!.vscode/settings.json -!.vscode/tasks.json -*.class -*.code-workspace -*.ctxt -*.iws -*.log -*.nar -*.rar -*.sublime-* -*.tar.gz -*.zip -.DS_Store -.classpath .gradle -.history -.kobalt -.mtj.tmp/ -.mvn/timing.properties -.mvn/wrapper/maven-wrapper.jar -.nb-gradle -.project -.scannerwork -.settings -.vscode/* -/**/.idea/$CACHE_FILE$ -/**/.idea/$PRODUCT_WORKSPACE_FILE$ -/**/.idea/**/caches/build_file_checksums.ser -/**/.idea/**/contentModel.xml -/**/.idea/**/dataSources.ids -/**/.idea/**/dataSources.local.xml -/**/.idea/**/dataSources/ -/**/.idea/**/dbnavigator.xml -/**/.idea/**/dictionaries -/**/.idea/**/dynamic.xml -/**/.idea/**/gradle.xml -/**/.idea/**/httpRequests -/**/.idea/**/libraries -/**/.idea/**/mongoSettings.xml -/**/.idea/**/replstate.xml -/**/.idea/**/shelf -/**/.idea/**/shelf/ -/**/.idea/**/sqlDataSources.xml -/**/.idea/**/tasks.xml -/**/.idea/**/uiDesigner.xml -/**/.idea/**/usage.statistics.xml -/**/.idea/**/workspace.xml -/**/.idea_modules/ -Thumbs.db -__pycache__ +.DS_Store +build +lib/bld/** +!lib/bld/bld-wrapper.jar +!lib/bld/bld-wrapper.properties +lib/compile/ +lib/runtime/ +lib/standalone/ +lib/test/ + +# IDEA ignores + +# User-specific +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin atlassian-ide-plugin.xml -bin/ -build/ -cmake-build-*/ -com_crashlytics_export_strings.xml -crashlytics-build.properties -crashlytics.properties -dependency-reduced-pom.xml -deploy/ -dist/ -ehthumbs.db -fabric.properties -gen/ -gradle.properties -hs_err_pid* -kobaltBuild -kobaltw*-test -lib/kotlin* -libs/ + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Editor-based Rest Client +.idea/httpRequests + +bin +deploy +target local.properties -out/ -pom.xml.asc -pom.xml.next -pom.xml.releaseBackup -pom.xml.tag -pom.xml.versionsBackup -proguard-project.txt -project.properties -release.properties -target/ -test-output -venv + diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 26820aa..10b9b0f 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,31 +1,24 @@ -image: gradle:alpine +image: fedora:latest variables: - GRADLE_OPTS: "-Dorg.gradle.daemon=false" - -before_script: - - export GRADLE_USER_HOME=`pwd`/.gradle + CI_NAME: "GitLab CI" stages: - - build - test -build: - stage: build - script: ./gradlew --build-cache assemble - cache: - key: "$CI_COMMIT_REF_NAME" - policy: push - paths: - - build - - .gradle +before_script: + - dnf -qy update && dnf -y install zip + - curl -s "https://get.sdkman.io" | bash + - echo sdkman_auto_answer=true > $HOME/.sdkman/etc/config + - echo sdkman_auto_selfupdate=true >> $HOME/.sdkman/etc/config + - source "$HOME/.sdkman/bin/sdkman-init.sh" + - sdk install java + - sdk install kotlin + - source "$HOME/.sdkman/bin/sdkman-init.sh" test: stage: test - script: ./gradlew check - cache: - key: "$CI_COMMIT_REF_NAME" - policy: pull - paths: - - build - - .gradle + script: + - ./bld download + - ./bld compile + - ./bld test diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 73f69e0..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml -# Editor-based HTTP Client requests -/httpRequests/ diff --git a/.idea/app.iml b/.idea/app.iml new file mode 100644 index 0000000..2c1fe21 --- /dev/null +++ b/.idea/app.iml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/bitly-shorten.iml b/.idea/bitly-shorten.iml deleted file mode 100644 index 78b2cc5..0000000 --- a/.idea/bitly-shorten.iml +++ /dev/null @@ -1,2 +0,0 @@ - - \ No newline at end of file diff --git a/.idea/bld.iml b/.idea/bld.iml new file mode 100644 index 0000000..e63e11e --- /dev/null +++ b/.idea/bld.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/encodings.xml b/.idea/bld.xml similarity index 54% rename from .idea/encodings.xml rename to .idea/bld.xml index 97626ba..6600cee 100644 --- a/.idea/encodings.xml +++ b/.idea/bld.xml @@ -1,6 +1,6 @@ - - + + \ No newline at end of file diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml deleted file mode 100644 index 21a0f73..0000000 --- a/.idea/checkstyle-idea.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml deleted file mode 100644 index d91f848..0000000 --- a/.idea/codeStyles/codeStyleConfig.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/copyright/BSD_3.xml b/.idea/copyright/BSD_3.xml new file mode 100644 index 0000000..dcac8a6 --- /dev/null +++ b/.idea/copyright/BSD_3.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/Erik_s_Copyright_Notice.xml b/.idea/copyright/Erik_s_Copyright_Notice.xml deleted file mode 100644 index 08660a1..0000000 --- a/.idea/copyright/Erik_s_Copyright_Notice.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml index 1419e40..3203074 100644 --- a/.idea/copyright/profiles_settings.xml +++ b/.idea/copyright/profiles_settings.xml @@ -1,3 +1,3 @@ - + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml index 8ff795e..94f28ea 100644 --- a/.idea/inspectionProfiles/Project_Default.xml +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -1,53 +1,9 @@ \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml deleted file mode 100644 index dc2dcae..0000000 --- a/.idea/inspectionProfiles/profiles_settings.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml new file mode 100644 index 0000000..c11c5e9 --- /dev/null +++ b/.idea/libraries/bld.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/compile.xml b/.idea/libraries/compile.xml new file mode 100644 index 0000000..99cc0c0 --- /dev/null +++ b/.idea/libraries/compile.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/runtime.xml b/.idea/libraries/runtime.xml new file mode 100644 index 0000000..d4069f2 --- /dev/null +++ b/.idea/libraries/runtime.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/test.xml b/.idea/libraries/test.xml new file mode 100644 index 0000000..57ed5ef --- /dev/null +++ b/.idea/libraries/test.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml index 05b6e27..f40d83c 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -1,24 +1,14 @@ - - \ No newline at end of file + diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..25946a1 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/.idea/runConfigurations/Run Tests.xml b/.idea/runConfigurations/Run Tests.xml new file mode 100644 index 0000000..64dfc8e --- /dev/null +++ b/.idea/runConfigurations/Run Tests.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml index 94a25f7..35eb1dd 100644 --- a/.idea/vcs.xml +++ b/.idea/vcs.xml @@ -1,6 +1,6 @@ - + \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 48c5805..0000000 --- a/.travis.yml +++ /dev/null @@ -1,26 +0,0 @@ -language: java -dist: trusty - -env: - global: - - CI=true - -#install: -# - git fetch --unshallow --tags - -addons: - sonarcloud: - organization: "ethauvin-github" - -jdk: - - oraclejdk8 - - openjdk14 - -before_install: - - chmod +x gradlew - -after_success: - - | - if [ "${TRAVIS_TEST_RESULT}" == 0 ] && [ "$TRAVIS_JDK_VERSION" == "openjdk14" ]; then - ./gradlew sonarqube - fi diff --git a/CHANGELOG.md b/CHANGELOG.md index a0d076e..dc6ac17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,30 @@ # Changelog +## [2.0.0](https://github.com/ethauvin/bitly-shorten/tree/1.0.0) (2024-05-23) + +[Full Changelog](https://github.com/ethauvin/bitly-shorten/compare/1.0.1...1.0.0) + +**Implemented enhancements:** + +- Implement DSL for deeplinks [\#16](https://github.com/ethauvin/bitly-shorten/issues/16) +- Implement custom bitlink update [\#15](https://github.com/ethauvin/bitly-shorten/issues/15) +- Update functions to match the bit.ly API [\#14](https://github.com/ethauvin/bitly-shorten/issues/14) + +## [1.0.1](https://github.com/ethauvin/bitly-shorten/tree/1.0.1) (2023-11-26) + +[Full Changelog](https://github.com/ethauvin/bitly-shorten/compare/1.0.0...1.0.1) + +## [1.0.0](https://github.com/ethauvin/bitly-shorten/tree/1.0.0) (2023-09-25) + +[Full Changelog](https://github.com/ethauvin/bitly-shorten/compare/0.9.3...1.0.0) + +**Implemented enhancements:** + +- Add message and description to CallResponse [\#12](https://github.com/ethauvin/bitly-shorten/issues/12) +- Add create config builder [\#10](https://github.com/ethauvin/bitly-shorten/issues/10) +- Add update config builder [\#8](https://github.com/ethauvin/bitly-shorten/issues/8) +- Implement additional HTTP status code in CallResponse [\#3](https://github.com/ethauvin/bitly-shorten/issues/3) + ## [0.9.3](https://github.com/ethauvin/bitly-shorten/tree/0.9.3) (2021-03-21) [Full Changelog](https://github.com/ethauvin/bitly-shorten/compare/0.9.2...0.9.3) diff --git a/LICENSE.txt b/LICENSE.txt index 15551d4..75e61da 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,5 +1,4 @@ -Copyright (c) 2020-2021, Erik C. Thauvin (erik@thauvin.net) -All rights reserved. +Copyright 2020-2025 Erik C. Thauvin (erik@thauvin.net) Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index 0f2ac81..02d7aae 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ -[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](http://opensource.org/licenses/BSD-3-Clause) [![Release](https://img.shields.io/github/release/ethauvin/bitly-shorten.svg)](https://github.com/ethauvin/bitly-shorten/releases/latest) [![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/bitly-shorten.svg?label=maven%20central)](https://search.maven.org/search?q=g:%22net.thauvin.erik%22%20AND%20a:%22bitly-shorten%22) +[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause) +[![Kotlin](https://img.shields.io/badge/kotlin-2.1.20-7f52ff)](https://kotlinlang.org/) +[![bld](https://img.shields.io/badge/2.2.1-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld) +[![Release](https://img.shields.io/github/release/ethauvin/bitly-shorten.svg)](https://github.com/ethauvin/bitly-shorten/releases/latest) +[![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/bitly-shorten.svg?color=blue)](https://central.sonatype.com/artifact/net.thauvin.erik/bitly-shorten) +[![Nexus Snapshot](https://img.shields.io/nexus/s/net.thauvin.erik/bitly-shorten?label=snapshot&server=https%3A%2F%2Foss.sonatype.org%2F)](https://oss.sonatype.org/content/repositories/snapshots/net/thauvin/erik/bitly-shorten/) -[![Known Vulnerabilities](https://snyk.io/test/github/ethauvin/bitly-shorten/badge.svg?targetFile=pom.xml)](https://snyk.io/test/github/ethauvin/bitly-shorten?targetFile=pom.xml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_bitly-shorten&metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_bitly-shorten) [![Build Status](https://travis-ci.com/ethauvin/bitly-shorten.svg?branch=master)](https://travis-ci.com/ethauvin/bitly-shorten) [![CircleCI](https://circleci.com/gh/ethauvin/bitly-shorten/tree/master.svg?style=shield)](https://circleci.com/gh/ethauvin/bitly-shorten/tree/master) -# [Bitly](https://dev.bitly.com/v4/) Shortener for Kotlin/Java/Android +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_bitly-shorten&metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_bitly-shorten) +[![GitHub CI](https://github.com/ethauvin/bitly-shorten/actions/workflows/bld.yml/badge.svg)](https://github.com/ethauvin/bitly-shorten/actions/workflows/bld.yml) +[![CircleCI](https://circleci.com/gh/ethauvin/bitly-shorten/tree/master.svg?style=shield)](https://circleci.com/gh/ethauvin/bitly-shorten/tree/master) -A simple implementation of the link shortening (Bitlinks) abilities of the [Bitly v4 API](https://dev.bitly.com/api-reference). +# [Bitly](https://dev.bitly.com/v4/) Shortener for Kotlin, Java & Android + +A simple implementation of the [Bitly](https://bit.ly/) link shortening (Bitlinks) [API v4](https://dev.bitly.com/api-reference). ## Examples (TL;DR) @@ -21,15 +29,15 @@ bitly.bitlinks().expand("https://bit.ly/380ojFd") bitly.bitlinks().clicks("https://bit.ly/380ojFd") // Create a bitlink -bitly.bitlinks().create(title = "Erik's Weblog", long_url = "https://erik.thauvin.net/blog/") +bitly.bitlinks().create(title="Erik's Weblog", long_url = "https://erik.thauvin.net/blog/") // Update a bitlink -bitly.bitlinks().update("https://bit.ly/380ojFd", title="Erik's Weblog", tags = arrayOf("blog", "weblog")) +bitly.bitlinks().update("https://bit.ly/380ojFd", title = "Erik's Weblog", tags = arrayOf("blog", "weblog")) ``` - - View [Kotlin](https://github.com/ethauvin/bitly-shorten/blob/master/examples/src/main/kotlin/com/example/BitlyExample.kt) or [Java](https://github.com/ethauvin/bitly-shorten/blob/master/examples/src/main/java/com/example/BitlySample.java) Examples. +- View [bld](https://github.com/ethauvin/bitly-shorten/blob/master/examples/bld) or [Gradle](https://github.com/ethauvin/bitly-shorten/blob/master/examples/gradle) Examples. -### API Access Token +## API Access Token The Bitly API [Access Token](https://bitly.is/accesstoken) can be specified directly as well as via the `BITLY_ACCESS_TOKEN` environment variable or properties key. @@ -41,30 +49,72 @@ val bitly = Bitly() val bitly = Bitly(File("my.properties")) ``` + ```ini # my.properties BITLY_ACCESS_TOKEN=abc123def456ghi789jkl0 ``` -### Gradle, Maven, etc. +## bld -To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/bitly-shorten/blob/master/examples/build.gradle.kts) file: +To use with [bld](https://rife2.com/bld), include the following dependency in your [build](https://github.com/ethauvin/bitly-shorten/blob/master/examples/bld/src/bld/java/com/example/ExampleBuild.java) file: + +```java +repositories = List.of(MAVEN_CENTRAL, SONATYPE_SNAPSHOTS_LEGACY); + +scope(compile) + .include(dependency("net.thauvin.erik:bitly-shorten:2.0.0")); +``` + +Be sure to use the [bld Kotlin extension](https://github.com/rife2/bld-kotlin) in your project. + +## Gradle, Maven, etc… + +To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/bitly-shorten/blob/master/examples/gradle/build.gradle.kts) file: ```gradle +repositories { + mavenCentral() + maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") } // only needed for SNAPSHOT +} + dependencies { - implementation("net.thauvin.erik:bitly-shorten:0.9.3") + implementation("net.thauvin.erik:bitly-shorten:2.0.0") } ``` -Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://search.maven.org/artifact/net.thauvin.erik/bitly-shorten/0.9.3/jar). +Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://central.sonatype.com/artifact/net.thauvin.erik/bitly-shorten). -### JSON +## Java + +To make it easier to use the library with Java, configuration builders are available: + +```java +var config = new CreateConfig.Builder("https://erik.thauvin.net/blog") + .title("Erik's Weblog") + .tags(new String[] { "blog", "weblog"}) + .build(); + +bitly.bitlinks().create(config); +``` + +```java +var config = new UpdateConfig.Builder("https://bit.ly/380ojFd") + .title("Erik's Weblog") + .tags(new String[] { "blog", "weblog"}) + .build(); + +bitly.bitlinks().update(config); +``` + +## JSON All implemented API calls can return the full JSON responses: ```kotlin bitly.bitlinks().shorten("https://www.erik.thauvin.net/blog", toJson = true) ``` + ```json { "created_at": "2020-02-26T06:50:08+0000", @@ -74,28 +124,31 @@ bitly.bitlinks().shorten("https://www.erik.thauvin.net/blog", toJson = true) } ``` +## API Response & Endpoints + You can also access the last response from implemented API calls using: ```kotlin val bitlinks = Bitlinks(apikey) - val shortUrl = bitlinks.shorten(longUrl) - val response = bitlinks.lastCallResponse if (response.isSuccessful) { println(response.body) +} else { + println("${response.message}: ${response.description} (${response.statusCode})") } ``` -Non-implemented API calls can also be called directly: +Non-implemented API endpoints can also be called directly: ```kotlin -val response = bitly.call("/user".toEndPoint(), method = Methods.GET) +val response = bitly.call("/user", method = Methods.GET) if (response.isSuccessful) { println(response.body) } ``` + ```json { "created": "2009-06-12T19:00:45+0000", @@ -115,7 +168,28 @@ if (response.isSuccessful) { "default_group_guid": "ABCde1f23gh" } ``` -- View [Example](https://github.com/ethauvin/bitly-shorten/blob/master/examples/src/main/kotlin/com/example/BitlyRetrieve.kt) -### More... +- View [Example](https://github.com/ethauvin/bitly-shorten/blob/master/examples/bld/src/main/kotlin/com/example/BitlyRetrieve.kt) + +## Contributing + +If you want to contribute to this project, all you have to do is clone the GitHub +repository: + +```console +git clone git@github.com:ethauvin/bitly-shorten.git +``` + +Then use [bld](https://rife2.com/bld) to build: + +```console +cd bitly-shorten +./bld compile +``` + +The project has an [IntelliJ IDEA](https://www.jetbrains.com/idea/) project structure. You can just open it after all +the dependencies were downloaded and peruse the code. + +## More… + If all else fails, there's always more [Documentation](https://ethauvin.github.io/bitly-shorten/). diff --git a/bitbucket-pipelines.yml b/bitbucket-pipelines.yml index 7d98402..ace99d2 100644 --- a/bitbucket-pipelines.yml +++ b/bitbucket-pipelines.yml @@ -1,9 +1,20 @@ -image: openjdk:8 +image: ubuntu:latest pipelines: default: - step: - caches: - - gradle + name: Test with bld script: - - bash ./gradlew check + # Install latest Java & Kotlin via SDKMAN! + - apt-get update -qq && apt-get install -y curl zip + - curl -s "https://get.sdkman.io" | bash + - echo sdkman_auto_answer=true > $HOME/.sdkman/etc/config + - echo sdkman_auto_selfupdate=true >> $HOME/.sdkman/etc/config + - source "$HOME/.sdkman/bin/sdkman-init.sh" + - sdk install java + - sdk install kotlin + - source "$HOME/.sdkman/bin/sdkman-init.sh" + # Download, compile and test with bld + - ./bld download + - ./bld compile + - ./bld test diff --git a/bld b/bld new file mode 100755 index 0000000..cdbee34 --- /dev/null +++ b/bld @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build net.thauvin.erik.bitly.BitlyShortenBuild "$@" \ No newline at end of file diff --git a/bld.bat b/bld.bat new file mode 100644 index 0000000..e728da9 --- /dev/null +++ b/bld.bat @@ -0,0 +1,4 @@ +@echo off +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build net.thauvin.erik.bitly.BitlyShortenBuild %* \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts deleted file mode 100644 index 78c13b1..0000000 --- a/build.gradle.kts +++ /dev/null @@ -1,226 +0,0 @@ -import org.jetbrains.kotlin.gradle.tasks.KotlinCompile -import java.net.URL - -plugins { - jacoco - `java-library` - `maven-publish` - signing - id("com.github.ben-manes.versions") version "0.38.0" - id("io.gitlab.arturbosch.detekt") version "1.16.0" - id("net.thauvin.erik.gradle.semver") version "1.0.4" - id("org.jetbrains.dokka") version "1.4.30" - id("org.jetbrains.kotlin.jvm") version "1.4.31" - id("org.jetbrains.kotlin.kapt") version "1.4.31" - id("org.sonarqube") version "3.1.1" -} - -group = "net.thauvin.erik" -description = "Bitly Shortener for Kotlin/Java" - -val gitHub = "ethauvin/$name" -val mavenUrl = "https://github.com/$gitHub" -val deployDir = "deploy" -var isRelease = "release" in gradle.startParameter.taskNames - -var semverProcessor = "net.thauvin.erik:semver:1.2.0" - -val publicationName = "mavenJava" - -object VersionInfo { - const val okhttp = "4.9.1" -} - -val versions: VersionInfo by extra { VersionInfo } - -repositories { - mavenCentral() - jcenter() // needed for dokka -} - -dependencies { - implementation("com.squareup.okhttp3:okhttp:${versions.okhttp}") - implementation("com.squareup.okhttp3:logging-interceptor:${versions.okhttp}") - implementation("org.json:json:20210307") - - // Use the Kotlin test library. - testImplementation("org.jetbrains.kotlin:kotlin-test") - // Use the Kotlin JUnit integration. - testImplementation("org.jetbrains.kotlin:kotlin-test-junit") -} - -kapt { - arguments { - arg("semver.project.dir", projectDir) - } -} - -detekt { - baseline = project.rootDir.resolve("config/detekt/baseline.xml") -} - -java { - sourceCompatibility = JavaVersion.VERSION_1_8 - targetCompatibility = JavaVersion.VERSION_1_8 - withSourcesJar() -} - -sonarqube { - properties { - property("sonar.projectKey", "ethauvin_$name") - property("sonar.sourceEncoding", "UTF-8") - } -} - -val javadocJar by tasks.creating(Jar::class) { - dependsOn(tasks.dokkaJavadoc) - from(tasks.dokkaJavadoc) - archiveClassifier.set("javadoc") - description = "Assembles a JAR of the generated Javadoc." - group = JavaBasePlugin.DOCUMENTATION_GROUP -} - -tasks { - withType { - reports { - xml.isEnabled = true - html.isEnabled = true - } - } - - withType().configureEach { - kotlinOptions.jvmTarget = "1.8" - } - - withType { - destination = file("$projectDir/pom.xml") - } - - assemble { - dependsOn(javadocJar) - } - - clean { - doLast { - project.delete(fileTree(deployDir)) - } - } - - dokkaHtml { - outputDirectory.set(file("$projectDir/docs")) - - dokkaSourceSets { - configureEach { - jdkVersion.set(8) - includes.from("config/dokka/packages.md") - sourceLink { - localDirectory.set(file("/src/main/kotlin/")) - remoteUrl.set(URL("https://github.com/ethauvin/${project.name}/tree/master/src/main/kotlin/")) - remoteLineSuffix.set("#L") - } - - } - } - } - - dokkaJavadoc { - dokkaSourceSets { - configureEach { - jdkVersion.set(8) - includes.from("config/dokka/packages.md") - } - } - dependsOn(dokkaHtml) - } - - val copyToDeploy by registering(Copy::class) { - from(configurations.runtimeClasspath) { - exclude("annotations-*.jar") - } - from(jar) - into(deployDir) - } - - register("deploy") { - description = "Copies all needed files to the $deployDir directory." - group = PublishingPlugin.PUBLISH_TASK_GROUP - dependsOn("build", "jar") - outputs.dir(deployDir) - inputs.files(copyToDeploy) - mustRunAfter("clean") - } - - val gitIsDirty by registering(Exec::class) { - description = "Fails if git has uncommitted changes." - group = "verification" - commandLine("git", "diff", "--quiet", "--exit-code") - } - - val gitTag by registering(Exec::class) { - description = "Tags the local repository with version ${project.version}" - group = PublishingPlugin.PUBLISH_TASK_GROUP - dependsOn(gitIsDirty) - if (isRelease) { - commandLine("git", "tag", "-a", project.version, "-m", "Version ${project.version}") - } - } - - register("release") { - description = "Publishes version ${project.version} to local repository." - group = PublishingPlugin.PUBLISH_TASK_GROUP - dependsOn("wrapper", "deploy", "gitTag", "publishToMavenLocal") - } - - "sonarqube" { - dependsOn("jacocoTestReport") - } -} - -publishing { - publications { - create(publicationName) { - from(components["java"]) - artifact(javadocJar) - pom { - name.set(project.name) - description.set(project.description) - url.set(mavenUrl) - licenses { - license { - name.set("BSD 3-Clause") - url.set("https://opensource.org/licenses/BSD-3-Clause") - } - } - developers { - developer { - id.set("ethauvin") - name.set("Erik C. Thauvin") - email.set("erik@thauvin.net") - url.set("https://erik.thauvin.net/") - } - } - scm { - connection.set("scm:git:git://github.com/$gitHub.git") - developerConnection.set("scm:git:git@github.com:$gitHub.git") - url.set("$mavenUrl") - } - issueManagement { - system.set("GitHub") - url.set("$mavenUrl/issues") - } - } - } - } - repositories { - maven { - name = "ossrh" - url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/") - credentials(PasswordCredentials::class) - } - } -} - -signing { - useGpgCmd() - sign(publishing.publications[publicationName]) -} diff --git a/config/detekt/baseline.xml b/config/detekt/baseline.xml index 0142bd2..dc8efc2 100644 --- a/config/detekt/baseline.xml +++ b/config/detekt/baseline.xml @@ -2,20 +2,47 @@ - ComplexMethod:Bitlinks.kt$Bitlinks$ @Synchronized @JvmOverloads fun update( bitlink: String, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false ): String - ComplexMethod:Utils.kt$Utils.Companion$ @JvmOverloads fun call( accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST ): CallResponse + ConstructorParameterNaming:CreateConfig.kt$CreateConfig.Builder$var long_url: String FunctionParameterNaming:Bitlinks.kt$Bitlinks$bitlink_id: String - FunctionParameterNaming:Bitlinks.kt$Bitlinks$client_id: String = Constants.EMPTY - FunctionParameterNaming:Bitlinks.kt$Bitlinks$created_at: String = Constants.EMPTY - FunctionParameterNaming:Bitlinks.kt$Bitlinks$created_by: String = Constants.EMPTY - FunctionParameterNaming:Bitlinks.kt$Bitlinks$custom_bitlinks: Array<String> = emptyArray() + FunctionParameterNaming:Bitlinks.kt$Bitlinks$custom_bitlink: String FunctionParameterNaming:Bitlinks.kt$Bitlinks$group_guid: String = Constants.EMPTY FunctionParameterNaming:Bitlinks.kt$Bitlinks$long_url: String - FunctionParameterNaming:Bitlinks.kt$Bitlinks$long_url: String = Constants.EMPTY FunctionParameterNaming:Bitlinks.kt$Bitlinks$unit_reference: String = Constants.EMPTY + FunctionParameterNaming:CreateConfig.kt$CreateConfig.Builder$group_guid: String + FunctionParameterNaming:CreateConfig.kt$CreateConfig.Builder$long_url: String + FunctionParameterNaming:CreateDeeplinks.kt$CreateDeeplinks$app_id: String + FunctionParameterNaming:CreateDeeplinks.kt$CreateDeeplinks$app_uri_path: String + FunctionParameterNaming:CreateDeeplinks.kt$CreateDeeplinks$install_type: InstallType + FunctionParameterNaming:CreateDeeplinks.kt$CreateDeeplinks$install_url: String + FunctionParameterNaming:UpdateDeeplinks.kt$UpdateDeeplinks$app_guid: String + FunctionParameterNaming:UpdateDeeplinks.kt$UpdateDeeplinks$app_uri_path: String + FunctionParameterNaming:UpdateDeeplinks.kt$UpdateDeeplinks$brand_guid: String + FunctionParameterNaming:UpdateDeeplinks.kt$UpdateDeeplinks$install_type: InstallType + FunctionParameterNaming:UpdateDeeplinks.kt$UpdateDeeplinks$install_url: String + LongParameterList:Bitlinks.kt$Bitlinks$( bitlink: String, title: String = Constants.EMPTY, archived: Boolean = false, tags: Array<String> = emptyArray(), deeplinks: UpdateDeeplinks = UpdateDeeplinks(), toJson: Boolean = false ) + LongParameterList:Bitlinks.kt$Bitlinks$( long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, title: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: CreateDeeplinks = CreateDeeplinks(), toJson: Boolean = false ) MagicNumber:CallResponse.kt$CallResponse$200 + MagicNumber:CallResponse.kt$CallResponse$201 MagicNumber:CallResponse.kt$CallResponse$299 - NestedBlockDepth:Utils.kt$Utils.Companion$ @JvmOverloads fun call( accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST ): CallResponse - NestedBlockDepth:Utils.kt$Utils.Companion$private fun parseBody(endPoint: String, result: Response): String + MagicNumber:CallResponse.kt$CallResponse$400 + MagicNumber:CallResponse.kt$CallResponse$402 + MagicNumber:CallResponse.kt$CallResponse$403 + MagicNumber:CallResponse.kt$CallResponse$404 + MagicNumber:CallResponse.kt$CallResponse$410 + MagicNumber:CallResponse.kt$CallResponse$417 + MagicNumber:CallResponse.kt$CallResponse$422 + MagicNumber:CallResponse.kt$CallResponse$429 + MagicNumber:CallResponse.kt$CallResponse$500 + MagicNumber:CallResponse.kt$CallResponse$503 + NestedBlockDepth:Bitlinks.kt$Bitlinks$private fun parseJsonResponse(response: CallResponse, key: String, default: String, toJson: Boolean): String + NestedBlockDepth:BitlyExample.kt$fun main(args: Array<String>) + NestedBlockDepth:Utils.kt$Utils$@JvmStatic @JvmOverloads fun call( accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST ): CallResponse + NestedBlockDepth:Utils.kt$Utils$private fun parseResponse(response: Response, endPoint: String): CallResponse + TooManyFunctions:UpdateDeeplinks.kt$UpdateDeeplinks + VariableNaming:CreateConfig.kt$CreateConfig$val group_guid = builder.group_guid + VariableNaming:CreateConfig.kt$CreateConfig$val long_url = builder.long_url + VariableNaming:CreateConfig.kt$CreateConfig.Builder$var group_guid: String = Constants.EMPTY + WildcardImport:BitlyTest.kt$import assertk.assertions.* + WildcardImport:BitlyTest.kt$import kotlin.test.* diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml deleted file mode 100644 index f24d8c1..0000000 --- a/config/detekt/detekt.yml +++ /dev/null @@ -1,551 +0,0 @@ -build: - maxIssues: 10 - weights: - # complexity: 2 - # LongParameterList: 1 - # style: 1 - # comments: 1 - -processors: - active: true - exclude: - # - 'DetektProgressListener' - # - 'FunctionCountProcessor' - # - 'PropertyCountProcessor' - # - 'ClassCountProcessor' - # - 'PackageCountProcessor' - # - 'KtFileCountProcessor' - -console-reports: - active: true - exclude: - # - 'ProjectStatisticsReport' - # - 'ComplexityReport' - # - 'NotificationReport' - # - 'FindingsReport' - # - 'BuildFailureReport' - -comments: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - CommentOverPrivateFunction: - active: false - CommentOverPrivateProperty: - active: false - EndOfSentenceFormat: - active: false - endOfSentenceFormat: ([.?!][ \t\n\r\f<])|([.?!:]$) - UndocumentedPublicClass: - active: false - searchInNestedClass: true - searchInInnerClass: true - searchInInnerObject: true - searchInInnerInterface: true - UndocumentedPublicFunction: - active: false - -complexity: - active: true - ComplexCondition: - active: true - threshold: 4 - ComplexInterface: - active: false - threshold: 10 - includeStaticDeclarations: false - ComplexMethod: - active: true - threshold: 10 - ignoreSingleWhenExpression: false - ignoreSimpleWhenEntries: false - LabeledExpression: - active: false - ignoredLabels: "" - LargeClass: - active: true - threshold: 600 - LongMethod: - active: true - threshold: 60 - LongParameterList: - active: false - constructorThreshold: 6 - functionThreshold: 6 - ignoreDefaultParameters: false - MethodOverloading: - active: false - threshold: 6 - NestedBlockDepth: - active: true - threshold: 4 - StringLiteralDuplication: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - threshold: 3 - ignoreAnnotation: true - excludeStringsWithLessThan5Characters: true - ignoreStringsRegex: '$^' - TooManyFunctions: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - thresholdInFiles: 11 - thresholdInClasses: 11 - thresholdInInterfaces: 11 - thresholdInObjects: 11 - thresholdInEnums: 11 - ignoreDeprecated: false - ignorePrivate: false - ignoreOverridden: false - -empty-blocks: - active: true - EmptyCatchBlock: - active: true - allowedExceptionNameRegex: "^(_|(ignore|expected).*)" - EmptyClassBlock: - active: true - EmptyDefaultConstructor: - active: true - EmptyDoWhileBlock: - active: true - EmptyElseBlock: - active: true - EmptyFinallyBlock: - active: true - EmptyForBlock: - active: true - EmptyFunctionBlock: - active: true - ignoreOverridden: false - EmptyIfBlock: - active: true - EmptyInitBlock: - active: true - EmptyKtFile: - active: true - EmptySecondaryConstructor: - active: true - EmptyWhenBlock: - active: true - EmptyWhileBlock: - active: true - -exceptions: - active: true - ExceptionRaisedInUnexpectedLocation: - active: false - methodNames: 'toString,hashCode,equals,finalize' - InstanceOfCheckForException: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - NotImplementedDeclaration: - active: false - PrintStackTrace: - active: false - RethrowCaughtException: - active: false - ReturnFromFinally: - active: false - SwallowedException: - active: false - ignoredExceptionTypes: 'InterruptedException,NumberFormatException,ParseException,MalformedURLException' - allowedExceptionNameRegex: "^(_|(ignore|expected).*)" - ThrowingExceptionFromFinally: - active: false - ThrowingExceptionInMain: - active: false - ThrowingExceptionsWithoutMessageOrCause: - active: false - exceptions: 'IllegalArgumentException,IllegalStateException,IOException' - ThrowingNewInstanceOfSameException: - active: false - TooGenericExceptionCaught: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - exceptionNames: - - ArrayIndexOutOfBoundsException - - Error - - Exception - - IllegalMonitorStateException - - NullPointerException - - IndexOutOfBoundsException - - RuntimeException - - Throwable - allowedExceptionNameRegex: "^(_|(ignore|expected).*)" - TooGenericExceptionThrown: - active: true - exceptionNames: - - Error - - Exception - - Throwable - - RuntimeException - -formatting: - active: true - android: false - autoCorrect: true - AnnotationOnSeparateLine: - active: false - autoCorrect: true - ChainWrapping: - active: true - autoCorrect: true - CommentSpacing: - active: true - autoCorrect: true - Filename: - active: true - FinalNewline: - active: true - autoCorrect: true - ImportOrdering: - active: false - autoCorrect: true - Indentation: - active: false - autoCorrect: true - indentSize: 4 - continuationIndentSize: 4 - MaximumLineLength: - active: true - maxLineLength: 120 - ModifierOrdering: - active: true - autoCorrect: true - MultiLineIfElse: - active: true - autoCorrect: true - NoBlankLineBeforeRbrace: - active: true - autoCorrect: true - NoConsecutiveBlankLines: - active: true - autoCorrect: true - NoEmptyClassBody: - active: true - autoCorrect: true - NoLineBreakAfterElse: - active: true - autoCorrect: true - NoLineBreakBeforeAssignment: - active: true - autoCorrect: true - NoMultipleSpaces: - active: true - autoCorrect: true - NoSemicolons: - active: true - autoCorrect: true - NoTrailingSpaces: - active: true - autoCorrect: true - NoUnitReturn: - active: true - autoCorrect: true - NoUnusedImports: - active: true - autoCorrect: true - NoWildcardImports: - active: true - PackageName: - active: true - autoCorrect: true - ParameterListWrapping: - active: true - autoCorrect: true - indentSize: 4 - SpacingAroundColon: - active: true - autoCorrect: true - SpacingAroundComma: - active: true - autoCorrect: true - SpacingAroundCurly: - active: true - autoCorrect: true - SpacingAroundDot: - active: true - autoCorrect: true - SpacingAroundKeyword: - active: true - autoCorrect: true - SpacingAroundOperators: - active: true - autoCorrect: true - SpacingAroundParens: - active: true - autoCorrect: true - SpacingAroundRangeOperator: - active: true - autoCorrect: true - StringTemplate: - active: true - autoCorrect: true - -naming: - active: true - ClassNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - classPattern: '[A-Z$][a-zA-Z0-9$]*' - ConstructorParameterNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - parameterPattern: '[a-z][A-Za-z0-9]*' - privateParameterPattern: '[a-z][A-Za-z0-9]*' - excludeClassPattern: '$^' - EnumNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*' - ForbiddenClassName: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - forbiddenName: '' - FunctionMaxLength: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - maximumFunctionNameLength: 30 - FunctionMinLength: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - minimumFunctionNameLength: 3 - FunctionNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$' - excludeClassPattern: '$^' - ignoreOverridden: true - FunctionParameterNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - parameterPattern: '[a-z][A-Za-z0-9]*' - excludeClassPattern: '$^' - ignoreOverridden: true - InvalidPackageDeclaration: - active: false - rootPackage: '' - MatchingDeclarationName: - active: true - MemberNameEqualsClassName: - active: false - ignoreOverridden: true - ObjectPropertyNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - constantPattern: '[A-Za-z][_A-Za-z0-9]*' - propertyPattern: '[A-Za-z][_A-Za-z0-9]*' - privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*' - PackageNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - packagePattern: '^[a-z]+(\.[a-z][A-Za-z0-9]*)*$' - TopLevelPropertyNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - constantPattern: '[A-Z][_A-Z0-9]*' - propertyPattern: '[A-Za-z][_A-Za-z0-9]*' - privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*' - VariableMaxLength: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - maximumVariableNameLength: 64 - VariableMinLength: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - minimumVariableNameLength: 1 - VariableNaming: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - variablePattern: '[a-z][A-Za-z0-9]*' - privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*' - excludeClassPattern: '$^' - ignoreOverridden: true - -performance: - active: true - ArrayPrimitive: - active: false - ForEachOnRange: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - SpreadOperator: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - UnnecessaryTemporaryInstantiation: - active: true - -potential-bugs: - active: true - DuplicateCaseInWhenExpression: - active: true - EqualsAlwaysReturnsTrueOrFalse: - active: false - EqualsWithHashCodeExist: - active: true - ExplicitGarbageCollectionCall: - active: true - InvalidRange: - active: false - IteratorHasNextCallsNextMethod: - active: false - IteratorNotThrowingNoSuchElementException: - active: false - LateinitUsage: - active: false - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - excludeAnnotatedProperties: "" - ignoreOnClassesPattern: "" - MissingWhenCase: - active: false - RedundantElseInWhen: - active: false - UnconditionalJumpStatementInLoop: - active: false - UnreachableCode: - active: true - UnsafeCallOnNullableType: - active: false - UnsafeCast: - active: false - UselessPostfixExpression: - active: false - WrongEqualsTypeParameter: - active: false - -style: - active: true - CollapsibleIfStatements: - active: false - DataClassContainsFunctions: - active: false - conversionFunctionPrefix: 'to' - DataClassShouldBeImmutable: - active: false - EqualsNullCall: - active: false - EqualsOnSignatureLine: - active: false - ExplicitItLambdaParameter: - active: false - ExpressionBodySyntax: - active: false - includeLineWrapping: false - ForbiddenComment: - active: true - values: 'TODO:,FIXME:,STOPSHIP:' - ForbiddenImport: - active: false - imports: '' - ForbiddenVoid: - active: false - ignoreOverridden: false - ignoreUsageInGenerics: false - FunctionOnlyReturningConstant: - active: false - ignoreOverridableFunction: true - excludedFunctions: 'describeContents' - LibraryCodeMustSpecifyReturnType: - active: false - LoopWithTooManyJumpStatements: - active: false - maxJumpCount: 1 - MagicNumber: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - ignoreNumbers: '-1,0,1,2' - ignoreHashCodeFunction: true - ignorePropertyDeclaration: false - ignoreConstantDeclaration: true - ignoreCompanionObjectPropertyDeclaration: true - ignoreAnnotation: false - ignoreNamedArgument: true - ignoreEnums: false - ignoreRanges: false - MandatoryBracesIfStatements: - active: false - MaxLineLength: - active: true - maxLineLength: 120 - excludePackageStatements: true - excludeImportStatements: true - excludeCommentStatements: false - MayBeConst: - active: false - ModifierOrder: - active: true - NestedClassesVisibility: - active: false - NewLineAtEndOfFile: - active: true - NoTabs: - active: false - OptionalAbstractKeyword: - active: true - OptionalUnit: - active: false - OptionalWhenBraces: - active: false - PreferToOverPairSyntax: - active: false - ProtectedMemberInFinalClass: - active: false - RedundantVisibilityModifierRule: - active: false - ReturnCount: - active: true - max: 2 - excludedFunctions: "equals" - excludeLabeled: false - excludeReturnFromLambda: true - SafeCast: - active: true - SerialVersionUIDInSerializableClass: - active: false - SpacingBetweenPackageAndImports: - active: false - ThrowsCount: - active: true - max: 2 - TrailingWhitespace: - active: false - UnderscoresInNumericLiterals: - active: false - acceptableDecimalLength: 5 - UnnecessaryAbstractClass: - active: false - excludeAnnotatedClasses: "dagger.Module" - UnnecessaryApply: - active: false - UnnecessaryInheritance: - active: false - UnnecessaryLet: - active: false - UnnecessaryParentheses: - active: false - UntilInsteadOfRangeTo: - active: false - UnusedImports: - active: false - UnusedPrivateClass: - active: false - UnusedPrivateMember: - active: false - allowedNames: "(_|ignored|expected|serialVersionUID)" - UseCheckOrError: - active: false - UseDataClass: - active: false - excludeAnnotatedClasses: "" - UseRequire: - active: false - UselessCallOnNotNull: - active: false - UtilityClassWithPublicConstructor: - active: false - VarCouldBeVal: - active: false - WildcardImport: - active: true - excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt" - excludeImports: 'java.util.*,kotlinx.android.synthetic.*' diff --git a/config/dokka/packages.md b/config/dokka/packages.md index 12c5f52..d808e00 100644 --- a/config/dokka/packages.md +++ b/config/dokka/packages.md @@ -1,9 +1,21 @@ # Module bitly-shorten -[Bitly Shortener for Kotlin/Java](https://github.com/ethauvin/bitly-shorten) +[Bitly Shortener for Kotlin, Java & Android](https://github.com/ethauvin/bitly-shorten) -A simple implementation of the link shortening (Bitlinks) abilities of the [Bitly API v4](https://dev.bitly.com/api-reference). +A simple implementation of the [Bitly](https://bit.ly/) link shortening (Bitlinks) [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/api-reference). + +# Package net.thauvin.erik.bitly.config + +Provides configuration builders for creating and updating Bitlinks. + +# Package net.thauvin.erik.bitly.config.deeplinks + +Provides deeplinks configurations for creating and updating Bitlinks. + +# Package net.thauvin.erik.bitly.config.deeplinks.enums + +Provides the deeplinks enumerations. diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..1759f99 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + AUTO_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/AUTO_INSTALL
+
+

AUTO_INSTALL

+
AUTO_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-n-o_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-n-o_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..179a8e5 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-n-o_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + NO_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/NO_INSTALL
+
+

NO_INSTALL

+
NO_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..341ee10 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + PROMOTE_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/PROMOTE_INSTALL
+
+

PROMOTE_INSTALL

+
PROMOTE_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/index.html new file mode 100644 index 0000000..6460f47 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/index.html @@ -0,0 +1,217 @@ + + + + + InstallType + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType
+
+

InstallType

+
enum InstallType : Enum<InstallType> (source)

Defines the installation types.

Since

2.0

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
NO_INSTALL
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
AUTO_INSTALL
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
PROMOTE_INSTALL
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): InstallType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<InstallType>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/type.html new file mode 100644 index 0000000..876846e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/type
+
+

type

+
+
val type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/value-of.html new file mode 100644 index 0000000..c8259b4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): InstallType(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/values.html new file mode 100644 index 0000000..5527682 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/values
+
+

values

+
+
fun values(): Array<InstallType>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-a-n-d-r-o-i-d/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-a-n-d-r-o-i-d/index.html new file mode 100644 index 0000000..f594ecc --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-a-n-d-r-o-i-d/index.html @@ -0,0 +1,134 @@ + + + + + ANDROID + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/Os/ANDROID
+
+

ANDROID

+
ANDROID
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-i-o-s/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-i-o-s/index.html new file mode 100644 index 0000000..f988122 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-i-o-s/index.html @@ -0,0 +1,134 @@ + + + + + IOS + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/Os/IOS
+
+

IOS

+
IOS
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/index.html new file mode 100644 index 0000000..0a4a370 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/index.html @@ -0,0 +1,202 @@ + + + + + Os + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/Os
+
+

Os

+
enum Os : Enum<Os> (source)

Defines the operating system types.

Since

2.0

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
IOS
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
ANDROID
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Os

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Os>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/type.html new file mode 100644 index 0000000..1c7c862 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/Os/type
+
+

type

+
+
val type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/value-of.html new file mode 100644 index 0000000..bf09e43 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/Os/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Os(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/values.html new file mode 100644 index 0000000..589b591 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums/Os/values
+
+

values

+
+
fun values(): Array<Os>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/index.html new file mode 100644 index 0000000..fa86d9c --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/index.html @@ -0,0 +1,119 @@ + + + + + net.thauvin.erik.bitly.config.deeplinks.enums + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks.enums
+
+

Package-level declarations

+

Provides the deeplinks enumerations.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum InstallType : Enum<InstallType>

Defines the installation types.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum Os : Enum<Os>

Defines the operating system types.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/-create-deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/-create-deeplinks.html new file mode 100644 index 0000000..102a2c2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/-create-deeplinks.html @@ -0,0 +1,80 @@ + + + + + CreateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/CreateDeeplinks
+
+

CreateDeeplinks

+
+
constructor()(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_id.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_id.html new file mode 100644 index 0000000..94db48f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_id.html @@ -0,0 +1,80 @@ + + + + + app_id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/app_id
+
+

app_id

+
+
fun app_id(app_id: String)(source)
fun app_id(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_uri_path.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_uri_path.html new file mode 100644 index 0000000..e9edb8a --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_uri_path.html @@ -0,0 +1,80 @@ + + + + + app_uri_path + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/app_uri_path
+
+

app_uri_path

+
+
fun app_uri_path(app_uri_path: String)(source)
fun app_uri_path(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/index.html new file mode 100644 index 0000000..d5d0430 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/index.html @@ -0,0 +1,198 @@ + + + + + CreateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks
+
+

CreateDeeplinks

+
class CreateDeeplinks(source)

Configures deeplinks used when creating Bitlinks.

See the Bit.ly API for more information.

Since

2.0

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor()
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_id(): String?
fun app_id(app_id: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_uri_path(): String?
fun app_uri_path(app_uri_path: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_type(): InstallType?
fun install_type(install_type: InstallType)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_url(): String?
fun install_url(install_url: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun isNotEmpty(): Boolean

Returns true if there are defined links.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun links(): Map<String, String>

Returns the links.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_type.html new file mode 100644 index 0000000..2b581e4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_type.html @@ -0,0 +1,80 @@ + + + + + install_type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/install_type
+
+

install_type

+
+
fun install_type(install_type: InstallType)(source)
fun install_type(): InstallType?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_url.html new file mode 100644 index 0000000..9678662 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_url.html @@ -0,0 +1,80 @@ + + + + + install_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/install_url
+
+

install_url

+
+
fun install_url(install_url: String)(source)
fun install_url(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/is-not-empty.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/is-not-empty.html new file mode 100644 index 0000000..a0ddb84 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/is-not-empty.html @@ -0,0 +1,80 @@ + + + + + isNotEmpty + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/isNotEmpty
+
+

isNotEmpty

+
+
fun isNotEmpty(): Boolean(source)

Returns true if there are defined links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/links.html new file mode 100644 index 0000000..20729fe --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/links.html @@ -0,0 +1,80 @@ + + + + + links + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/links
+
+

links

+
+
fun links(): Map<String, String>(source)

Returns the links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..ba97e75 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + AUTO_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType/AUTO_INSTALL
+
+

AUTO_INSTALL

+
AUTO_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-n-o_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-n-o_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..2e46558 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-n-o_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + NO_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType/NO_INSTALL
+
+

NO_INSTALL

+
NO_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..b7a7ded --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + PROMOTE_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType/PROMOTE_INSTALL
+
+

PROMOTE_INSTALL

+
PROMOTE_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/index.html new file mode 100644 index 0000000..9dfc398 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/index.html @@ -0,0 +1,217 @@ + + + + + InstallType + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType
+
+

InstallType

+
enum InstallType : Enum<InstallType> (source)

Defines the installation types.

Since

2.0

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
NO_INSTALL
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
AUTO_INSTALL
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
PROMOTE_INSTALL
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): InstallType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<InstallType>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/type.html new file mode 100644 index 0000000..d1c4993 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType/type
+
+

type

+
+
val type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/value-of.html new file mode 100644 index 0000000..45d7122 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): InstallType(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/values.html new file mode 100644 index 0000000..d6194aa --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-install-type/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/InstallType/values
+
+

values

+
+
fun values(): Array<InstallType>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/-a-n-d-r-o-i-d/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/-a-n-d-r-o-i-d/index.html new file mode 100644 index 0000000..b2b5366 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/-a-n-d-r-o-i-d/index.html @@ -0,0 +1,134 @@ + + + + + ANDROID + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/Os/ANDROID
+
+

ANDROID

+
ANDROID
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/-i-o-s/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/-i-o-s/index.html new file mode 100644 index 0000000..b3cf256 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/-i-o-s/index.html @@ -0,0 +1,134 @@ + + + + + IOS + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/Os/IOS
+
+

IOS

+
IOS
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/index.html new file mode 100644 index 0000000..66c8cd8 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/index.html @@ -0,0 +1,202 @@ + + + + + Os + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/Os
+
+

Os

+
enum Os : Enum<Os> (source)

Defines the operating system types.

Since

2.0

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
IOS
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
ANDROID
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Os

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Os>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/type.html new file mode 100644 index 0000000..80adbe1 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/Os/type
+
+

type

+
+
val type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/value-of.html new file mode 100644 index 0000000..a521eeb --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/Os/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Os(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/values.html new file mode 100644 index 0000000..417a6d4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-os/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/Os/values
+
+

values

+
+
fun values(): Array<Os>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/-update-deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/-update-deeplinks.html new file mode 100644 index 0000000..a06648f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/-update-deeplinks.html @@ -0,0 +1,80 @@ + + + + + UpdateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/UpdateDeeplinks
+
+

UpdateDeeplinks

+
+
constructor()(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_guid.html new file mode 100644 index 0000000..5f66075 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_guid.html @@ -0,0 +1,80 @@ + + + + + app_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/app_guid
+
+

app_guid

+
+
fun app_guid(app_guid: String)(source)
fun app_guid(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_uri_path.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_uri_path.html new file mode 100644 index 0000000..85bf02d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_uri_path.html @@ -0,0 +1,80 @@ + + + + + app_uri_path + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/app_uri_path
+
+

app_uri_path

+
+
fun app_uri_path(app_uri_path: String)(source)
fun app_uri_path(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/bitlink.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/bitlink.html new file mode 100644 index 0000000..3990dd5 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/bitlink
+
+

bitlink

+
+
fun bitlink(bitlink: String)(source)
fun bitlink(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/brand_guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/brand_guid.html new file mode 100644 index 0000000..a2d46f0 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/brand_guid.html @@ -0,0 +1,80 @@ + + + + + brand_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/brand_guid
+
+

brand_guid

+
+
fun brand_guid(brand_guid: String)(source)
fun brand_guid(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/created.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/created.html new file mode 100644 index 0000000..cb696b2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/created.html @@ -0,0 +1,80 @@ + + + + + created + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/created
+
+

created

+
+
fun created(created: String)(source)
fun created(created: ZonedDateTime)(source)

ISO timestamp.

fun created(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/guid.html new file mode 100644 index 0000000..73895eb --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/guid.html @@ -0,0 +1,80 @@ + + + + + guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/guid
+
+

guid

+
+
fun guid(guid: String)(source)
fun guid(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/index.html new file mode 100644 index 0000000..9977c15 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/index.html @@ -0,0 +1,288 @@ + + + + + UpdateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks
+
+

UpdateDeeplinks

+
class UpdateDeeplinks(source)

Configures deeplinks used when updating Bitlinks.

See the Bit.ly API for more information.

Since

2.0

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor()
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_guid(): String?
fun app_guid(app_guid: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_uri_path(): String?
fun app_uri_path(app_uri_path: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlink(): String?
fun bitlink(bitlink: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun brand_guid(): String?
fun brand_guid(brand_guid: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun created(): String?

fun created(created: ZonedDateTime)
fun created(created: String)

ISO timestamp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun guid(): String?
fun guid(guid: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_type(): InstallType?
fun install_type(install_type: InstallType)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_url(): String?
fun install_url(install_url: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun isNotEmpty(): Boolean

Returns true if there are defined links.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun links(): Map<String, String>

Returns the links.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun modified(): String?

fun modified(modified: ZonedDateTime)
fun modified(modified: String)

ISO timestamp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun os(): Os?
fun os(os: Os)
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_type.html new file mode 100644 index 0000000..0014241 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_type.html @@ -0,0 +1,80 @@ + + + + + install_type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/install_type
+
+

install_type

+
+
fun install_type(install_type: InstallType)(source)
fun install_type(): InstallType?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_url.html new file mode 100644 index 0000000..f60480f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_url.html @@ -0,0 +1,80 @@ + + + + + install_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/install_url
+
+

install_url

+
+
fun install_url(install_url: String)(source)
fun install_url(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/is-not-empty.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/is-not-empty.html new file mode 100644 index 0000000..2eec99f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/is-not-empty.html @@ -0,0 +1,80 @@ + + + + + isNotEmpty + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/isNotEmpty
+
+

isNotEmpty

+
+
fun isNotEmpty(): Boolean(source)

Returns true if there are defined links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/links.html new file mode 100644 index 0000000..73750b5 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/links.html @@ -0,0 +1,80 @@ + + + + + links + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/links
+
+

links

+
+
fun links(): Map<String, String>(source)

Returns the links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/modified.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/modified.html new file mode 100644 index 0000000..a6e8b1a --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/modified.html @@ -0,0 +1,80 @@ + + + + + modified + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/modified
+
+

modified

+
+
fun modified(modified: String)(source)
fun modified(modified: ZonedDateTime)(source)

ISO timestamp.

fun modified(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/os.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/os.html new file mode 100644 index 0000000..1c3a4e1 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/os.html @@ -0,0 +1,80 @@ + + + + + os + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/os
+
+

os

+
+
fun os(os: Os)(source)
fun os(): Os?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/index.html new file mode 100644 index 0000000..75ef5ca --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/index.html @@ -0,0 +1,119 @@ + + + + + net.thauvin.erik.bitly.config.deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config.deeplinks
+
+

Package-level declarations

+

Provides deeplinks configurations for creating and updating Bitlinks.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
class CreateDeeplinks

Configures deeplinks used when creating Bitlinks.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class UpdateDeeplinks

Configures deeplinks used when updating Bitlinks.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html new file mode 100644 index 0000000..283d38d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/Builder
+
+

Builder

+
+
constructor(long_url: String)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html new file mode 100644 index 0000000..92e5ad9 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/build
+
+

build

+
+
fun build(): CreateConfig(source)

Builds the configuration.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html new file mode 100644 index 0000000..152aa0c --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html @@ -0,0 +1,80 @@ + + + + + deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/deeplinks
+
+

deeplinks

+
+
fun deeplinks(deeplinks: CreateDeeplinks): CreateConfig.Builder(source)
var deeplinks: CreateDeeplinks(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html new file mode 100644 index 0000000..0a9fbe7 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html @@ -0,0 +1,80 @@ + + + + + domain + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/domain
+
+

domain

+
+
fun domain(domain: String): CreateConfig.Builder(source)

A branded short domain or bit.ly by default.

var domain: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html new file mode 100644 index 0000000..f5ea99d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html @@ -0,0 +1,80 @@ + + + + + groupGuid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/groupGuid
+
+

groupGuid

+
+
fun groupGuid(group_guid: String): CreateConfig.Builder(source)

Always include a specific group and custom domain in your shorten calls.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group_guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group_guid.html new file mode 100644 index 0000000..278de99 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group_guid.html @@ -0,0 +1,80 @@ + + + + + group_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/group_guid
+
+

group_guid

+
+
var group_guid: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html new file mode 100644 index 0000000..eb581ad --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html @@ -0,0 +1,337 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder
+
+

Builder

+
data class Builder(var long_url: String)(source)

Configures the creation parameters of a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(long_url: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var deeplinks: CreateDeeplinks
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var domain: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var group_guid: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var long_url: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var toJson: Boolean
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): CreateConfig

Builds the configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun domain(domain: String): CreateConfig.Builder

A branded short domain or bit.ly by default.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun groupGuid(group_guid: String): CreateConfig.Builder

Always include a specific group and custom domain in your shorten calls.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun longUrl(long_url: String): CreateConfig.Builder

The long URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun tags(tags: Array<String>): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun title(title: String): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun toJson(toJson: Boolean): CreateConfig.Builder

Returns the full JSON response if true.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html new file mode 100644 index 0000000..d7cf154 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html @@ -0,0 +1,80 @@ + + + + + longUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/longUrl
+
+

longUrl

+
+
fun longUrl(long_url: String): CreateConfig.Builder(source)

The long URL.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long_url.html new file mode 100644 index 0000000..f0e16ab --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/long_url
+
+

long_url

+
+
var long_url: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html new file mode 100644 index 0000000..1b72fdd --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/tags
+
+

tags

+
+
fun tags(tags: Array<String>): CreateConfig.Builder(source)
var tags: Array<String>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html new file mode 100644 index 0000000..3a5be40 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/title
+
+

title

+
+
fun title(title: String): CreateConfig.Builder(source)
var title: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html new file mode 100644 index 0000000..8e317e4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/toJson
+
+

toJson

+
+
fun toJson(toJson: Boolean): CreateConfig.Builder(source)

Returns the full JSON response if true.

var toJson: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-create-config.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-create-config.html new file mode 100644 index 0000000..e2bbce3 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-create-config.html @@ -0,0 +1,80 @@ + + + + + CreateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/CreateConfig
+
+

CreateConfig

+
+
constructor(builder: CreateConfig.Builder)(source)
constructor(long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, title: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: CreateDeeplinks = CreateDeeplinks(), toJson: Boolean = false)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html new file mode 100644 index 0000000..a1e86fa --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/deepLinks
+
+

deepLinks

+
+
val deepLinks: Array<Map<String, String>>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deeplinks.html new file mode 100644 index 0000000..43be944 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deeplinks.html @@ -0,0 +1,80 @@ + + + + + deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/deeplinks
+
+

deeplinks

+
+
var deeplinks: CreateDeeplinks(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/domain.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/domain.html new file mode 100644 index 0000000..ebb7224 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/domain.html @@ -0,0 +1,80 @@ + + + + + domain + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/domain
+
+

domain

+
+
var domain: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html new file mode 100644 index 0000000..3c80f33 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html @@ -0,0 +1,80 @@ + + + + + group_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/group_guid
+
+

group_guid

+
+
var group_guid: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/index.html new file mode 100644 index 0000000..3d58a28 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/index.html @@ -0,0 +1,232 @@ + + + + + CreateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig
+
+

CreateConfig

+
class CreateConfig constructor(var long_url: String, var domain: String = Constants.EMPTY, var group_guid: String = Constants.EMPTY, var title: String = Constants.EMPTY, var tags: Array<String> = emptyArray(), var deeplinks: CreateDeeplinks = CreateDeeplinks(), var toJson: Boolean = false)(source)

Provides a configuration to create a Bitlink

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(builder: CreateConfig.Builder)
constructor(long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, title: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: CreateDeeplinks = CreateDeeplinks(), toJson: Boolean = false)
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(var long_url: String)

Configures the creation parameters of a Bitlink.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var deeplinks: CreateDeeplinks
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var domain: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var group_guid: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var long_url: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var toJson: Boolean
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html new file mode 100644 index 0000000..625d737 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/long_url
+
+

long_url

+
+
var long_url: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/tags.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/tags.html new file mode 100644 index 0000000..ed0ac0e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/tags
+
+

tags

+
+
var tags: Array<String>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/title.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/title.html new file mode 100644 index 0000000..8398818 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/title
+
+

title

+
+
var title: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html new file mode 100644 index 0000000..b7b35c4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/CreateConfig/toJson
+
+

toJson

+
+
var toJson: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html new file mode 100644 index 0000000..d2c189f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/Builder
+
+

Builder

+
+
constructor(bitlink: String)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html new file mode 100644 index 0000000..614c33b --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html @@ -0,0 +1,80 @@ + + + + + archived + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/archived
+
+

archived

+
+
fun archived(archived: Boolean): UpdateConfig.Builder(source)
var archived: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html new file mode 100644 index 0000000..2502a6b --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/bitlink
+
+

bitlink

+
+
fun bitlink(bitlink: String): UpdateConfig.Builder(source)

A Bitlink made of the domain and hash.

var bitlink: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html new file mode 100644 index 0000000..59e9a96 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/build
+
+

build

+
+
fun build(): UpdateConfig(source)

Builds the configuration.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html new file mode 100644 index 0000000..9acc617 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html @@ -0,0 +1,80 @@ + + + + + clientId + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/clientId
+
+

clientId

+
+
fun clientId(clientId: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html new file mode 100644 index 0000000..6cb8ea7 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html @@ -0,0 +1,80 @@ + + + + + createdAt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/createdAt
+
+

createdAt

+
+
fun createdAt(createdAt: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html new file mode 100644 index 0000000..9111f41 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html @@ -0,0 +1,80 @@ + + + + + createdBy + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/createdBy
+
+

createdBy

+
+
fun createdBy(createdBy: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html new file mode 100644 index 0000000..9aa4f53 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html @@ -0,0 +1,80 @@ + + + + + customBitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/customBitlinks
+
+

customBitlinks

+
+
fun customBitlinks(customBitlinks: Array<String>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html new file mode 100644 index 0000000..37af8e3 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/deepLinks
+
+

deepLinks

+
+
fun deepLinks(deepLinks: Array<Map<String, String>>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deeplinks.html new file mode 100644 index 0000000..602177d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deeplinks.html @@ -0,0 +1,80 @@ + + + + + deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/deeplinks
+
+

deeplinks

+
+
fun deeplinks(deeplinks: UpdateDeeplinks): UpdateConfig.Builder(source)
var deeplinks: UpdateDeeplinks(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html new file mode 100644 index 0000000..2507cee --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html @@ -0,0 +1,80 @@ + + + + + id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/id
+
+

id

+
+
fun id(id: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html new file mode 100644 index 0000000..43f1d83 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html @@ -0,0 +1,307 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder
+
+

Builder

+
data class Builder(var bitlink: String)(source)

Configures the update parameters of a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(bitlink: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var archived: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var bitlink: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var deeplinks: UpdateDeeplinks
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var toJson: Boolean
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun archived(archived: Boolean): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlink(bitlink: String): UpdateConfig.Builder

A Bitlink made of the domain and hash.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): UpdateConfig

Builds the configuration.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun tags(tags: Array<String>): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun title(title: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun toJson(toJson: Boolean): UpdateConfig.Builder

Returns the full JSON response if true.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html new file mode 100644 index 0000000..7800c87 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html @@ -0,0 +1,80 @@ + + + + + link + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/link
+
+

link

+
+
fun link(link: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html new file mode 100644 index 0000000..7c64215 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html @@ -0,0 +1,80 @@ + + + + + longUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/longUrl
+
+

longUrl

+
+
fun longUrl(longUrl: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html new file mode 100644 index 0000000..aa3ccf2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html @@ -0,0 +1,80 @@ + + + + + references + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/references
+
+

references

+
+
fun references(references: Map<String, String>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html new file mode 100644 index 0000000..7ec41c3 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/tags
+
+

tags

+
+
fun tags(tags: Array<String>): UpdateConfig.Builder(source)
var tags: Array<String>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html new file mode 100644 index 0000000..d7a531c --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/title
+
+

title

+
+
fun title(title: String): UpdateConfig.Builder(source)
var title: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html new file mode 100644 index 0000000..3f09e17 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/toJson
+
+

toJson

+
+
fun toJson(toJson: Boolean): UpdateConfig.Builder(source)

Returns the full JSON response if true.

var toJson: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-update-config.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-update-config.html new file mode 100644 index 0000000..00d5101 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-update-config.html @@ -0,0 +1,80 @@ + + + + + UpdateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/UpdateConfig
+
+

UpdateConfig

+
+
constructor(builder: UpdateConfig.Builder)(source)
constructor(bitlink: String, title: String = Constants.EMPTY, archived: Boolean = false, tags: Array<String> = emptyArray(), deeplinks: UpdateDeeplinks = UpdateDeeplinks(), toJson: Boolean = false)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/archived.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/archived.html new file mode 100644 index 0000000..7fe17fc --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/archived.html @@ -0,0 +1,80 @@ + + + + + archived + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/archived
+
+

archived

+
+
var archived: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html new file mode 100644 index 0000000..df7726a --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/bitlink
+
+

bitlink

+
+
var bitlink: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html new file mode 100644 index 0000000..65e5dab --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html @@ -0,0 +1,80 @@ + + + + + client_id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/client_id
+
+

client_id

+
+
val client_id: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html new file mode 100644 index 0000000..26c1637 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html @@ -0,0 +1,80 @@ + + + + + created_at + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/created_at
+
+

created_at

+
+
val created_at: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html new file mode 100644 index 0000000..111fe54 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html @@ -0,0 +1,80 @@ + + + + + created_by + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/created_by
+
+

created_by

+
+
val created_by: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html new file mode 100644 index 0000000..d5396b6 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html @@ -0,0 +1,80 @@ + + + + + custom_bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/custom_bitlinks
+
+

custom_bitlinks

+
+
val custom_bitlinks: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html new file mode 100644 index 0000000..c769419 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/deepLinks
+
+

deepLinks

+
+
val deepLinks: Array<Map<String, String>>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deeplinks.html new file mode 100644 index 0000000..2426dc5 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deeplinks.html @@ -0,0 +1,80 @@ + + + + + deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/deeplinks
+
+

deeplinks

+
+
var deeplinks: UpdateDeeplinks(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/id.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/id.html new file mode 100644 index 0000000..027c678 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/id.html @@ -0,0 +1,80 @@ + + + + + id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/id
+
+

id

+
+
val id: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/index.html new file mode 100644 index 0000000..39fd00e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/index.html @@ -0,0 +1,217 @@ + + + + + UpdateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig
+
+

UpdateConfig

+
class UpdateConfig constructor(var bitlink: String, var title: String = Constants.EMPTY, var archived: Boolean = false, var tags: Array<String> = emptyArray(), var deeplinks: UpdateDeeplinks = UpdateDeeplinks(), var toJson: Boolean = false)(source)

Provides a configuration to update a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(builder: UpdateConfig.Builder)
constructor(bitlink: String, title: String = Constants.EMPTY, archived: Boolean = false, tags: Array<String> = emptyArray(), deeplinks: UpdateDeeplinks = UpdateDeeplinks(), toJson: Boolean = false)
+
+
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(var bitlink: String)

Configures the update parameters of a Bitlink.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var archived: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var bitlink: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var deeplinks: UpdateDeeplinks
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
var toJson: Boolean
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/link.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/link.html new file mode 100644 index 0000000..7a2cd46 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/link.html @@ -0,0 +1,80 @@ + + + + + link + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/link
+
+

link

+
+
val link: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html new file mode 100644 index 0000000..3f040d3 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/long_url
+
+

long_url

+
+
val long_url: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/references.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/references.html new file mode 100644 index 0000000..eada1f0 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/references.html @@ -0,0 +1,80 @@ + + + + + references + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/references
+
+

references

+
+
val references: Map<String, String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/tags.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/tags.html new file mode 100644 index 0000000..3354849 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/tags
+
+

tags

+
+
var tags: Array<String>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/title.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/title.html new file mode 100644 index 0000000..f050a11 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/title
+
+

title

+
+
var title: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html new file mode 100644 index 0000000..48f757a --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config/UpdateConfig/toJson
+
+

toJson

+
+
var toJson: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.config/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/index.html new file mode 100644 index 0000000..6e41b87 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.config/index.html @@ -0,0 +1,119 @@ + + + + + net.thauvin.erik.bitly.config + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.config
+
+

Package-level declarations

+

Provides configuration builders for creating and updating Bitlinks.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
class CreateConfig constructor(var long_url: String, var domain: String = Constants.EMPTY, var group_guid: String = Constants.EMPTY, var title: String = Constants.EMPTY, var tags: Array<String> = emptyArray(), var deeplinks: CreateDeeplinks = CreateDeeplinks(), var toJson: Boolean = false)

Provides a configuration to create a Bitlink

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class UpdateConfig constructor(var bitlink: String, var title: String = Constants.EMPTY, var archived: Boolean = false, var tags: Array<String> = emptyArray(), var deeplinks: UpdateDeeplinks = UpdateDeeplinks(), var toJson: Boolean = false)

Provides a configuration to update a Bitlink.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/-create-deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/-create-deeplinks.html new file mode 100644 index 0000000..51c8b66 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/-create-deeplinks.html @@ -0,0 +1,80 @@ + + + + + CreateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/CreateDeeplinks
+
+

CreateDeeplinks

+
+
constructor()(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/app_id.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/app_id.html new file mode 100644 index 0000000..22423d9 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/app_id.html @@ -0,0 +1,80 @@ + + + + + app_id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/app_id
+
+

app_id

+
+
fun app_id(app_id: String)(source)
fun app_id(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/app_uri_path.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/app_uri_path.html new file mode 100644 index 0000000..85b54f2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/app_uri_path.html @@ -0,0 +1,80 @@ + + + + + app_uri_path + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/app_uri_path
+
+

app_uri_path

+
+
fun app_uri_path(app_uri_path: String)(source)
fun app_uri_path(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/index.html new file mode 100644 index 0000000..c5e9bf6 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/index.html @@ -0,0 +1,198 @@ + + + + + CreateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks
+
+

CreateDeeplinks

+
class CreateDeeplinks(source)

Configures deeplinks used when creating Bitlinks.

See the Bit.ly API for more information.

Since

2.0

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor()
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_id(): String?
fun app_id(app_id: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_uri_path(): String?
fun app_uri_path(app_uri_path: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_type(): InstallType?
fun install_type(install_type: InstallType)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_url(): String?
fun install_url(install_url: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun isNotEmpty(): Boolean

Returns true if there are defined links.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun links(): Map<String, String>

Returns the links.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/install_type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/install_type.html new file mode 100644 index 0000000..82e8a42 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/install_type.html @@ -0,0 +1,80 @@ + + + + + install_type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/install_type
+
+

install_type

+
+
fun install_type(install_type: InstallType)(source)
fun install_type(): InstallType?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/install_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/install_url.html new file mode 100644 index 0000000..b554800 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/install_url.html @@ -0,0 +1,80 @@ + + + + + install_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/install_url
+
+

install_url

+
+
fun install_url(install_url: String)(source)
fun install_url(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/is-not-empty.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/is-not-empty.html new file mode 100644 index 0000000..c554a03 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/is-not-empty.html @@ -0,0 +1,80 @@ + + + + + isNotEmpty + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/isNotEmpty
+
+

isNotEmpty

+
+
fun isNotEmpty(): Boolean(source)

Returns true if there are defined links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/links.html new file mode 100644 index 0000000..db0451f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-create-deeplinks/links.html @@ -0,0 +1,80 @@ + + + + + links + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/CreateDeeplinks/links
+
+

links

+
+
fun links(): Map<String, String>(source)

Returns the links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..375949e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + AUTO_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType/AUTO_INSTALL
+
+

AUTO_INSTALL

+
AUTO_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-n-o_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-n-o_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..1936944 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-n-o_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + NO_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType/NO_INSTALL
+
+

NO_INSTALL

+
NO_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html new file mode 100644 index 0000000..deeba24 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html @@ -0,0 +1,134 @@ + + + + + PROMOTE_INSTALL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType/PROMOTE_INSTALL
+
+

PROMOTE_INSTALL

+
PROMOTE_INSTALL
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/index.html new file mode 100644 index 0000000..8073051 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/index.html @@ -0,0 +1,217 @@ + + + + + InstallType + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType
+
+

InstallType

+
enum InstallType : Enum<InstallType> (source)

Defines the installation types.

Since

2.0

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
NO_INSTALL
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
AUTO_INSTALL
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
PROMOTE_INSTALL
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): InstallType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<InstallType>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/type.html new file mode 100644 index 0000000..d573c1f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType/type
+
+

type

+
+
val type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/value-of.html new file mode 100644 index 0000000..6aebe18 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): InstallType(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/values.html new file mode 100644 index 0000000..bb0a71d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-install-type/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/InstallType/values
+
+

values

+
+
fun values(): Array<InstallType>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/-a-n-d-r-o-i-d/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/-a-n-d-r-o-i-d/index.html new file mode 100644 index 0000000..74910da --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/-a-n-d-r-o-i-d/index.html @@ -0,0 +1,134 @@ + + + + + ANDROID + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/Os/ANDROID
+
+

ANDROID

+
ANDROID
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/-i-o-s/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/-i-o-s/index.html new file mode 100644 index 0000000..1a97c5a --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/-i-o-s/index.html @@ -0,0 +1,134 @@ + + + + + IOS + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/Os/IOS
+
+

IOS

+
IOS
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/index.html new file mode 100644 index 0000000..38c77f2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/index.html @@ -0,0 +1,202 @@ + + + + + Os + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/Os
+
+

Os

+
enum Os : Enum<Os> (source)

Defines the operating system types.

Since

2.0

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
IOS
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
ANDROID
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: String
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Os

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Os>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/type.html new file mode 100644 index 0000000..35bd77e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/type.html @@ -0,0 +1,80 @@ + + + + + type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/Os/type
+
+

type

+
+
val type: String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/value-of.html new file mode 100644 index 0000000..a46165e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/Os/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Os(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/values.html new file mode 100644 index 0000000..8c8223c --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-os/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/Os/values
+
+

values

+
+
fun values(): Array<Os>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/-update-deeplinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/-update-deeplinks.html new file mode 100644 index 0000000..a423514 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/-update-deeplinks.html @@ -0,0 +1,80 @@ + + + + + UpdateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/UpdateDeeplinks
+
+

UpdateDeeplinks

+
+
constructor()(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/app_guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/app_guid.html new file mode 100644 index 0000000..12e8f46 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/app_guid.html @@ -0,0 +1,80 @@ + + + + + app_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/app_guid
+
+

app_guid

+
+
fun app_guid(app_guid: String)(source)
fun app_guid(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/app_uri_path.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/app_uri_path.html new file mode 100644 index 0000000..07d5cdc --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/app_uri_path.html @@ -0,0 +1,80 @@ + + + + + app_uri_path + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/app_uri_path
+
+

app_uri_path

+
+
fun app_uri_path(app_uri_path: String)(source)
fun app_uri_path(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/bitlink.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/bitlink.html new file mode 100644 index 0000000..c165f77 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/bitlink
+
+

bitlink

+
+
fun bitlink(bitlink: String)(source)
fun bitlink(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/brand_guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/brand_guid.html new file mode 100644 index 0000000..828f6b2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/brand_guid.html @@ -0,0 +1,80 @@ + + + + + brand_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/brand_guid
+
+

brand_guid

+
+
fun brand_guid(brand_guid: String)(source)
fun brand_guid(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/created.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/created.html new file mode 100644 index 0000000..215b8ee --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/created.html @@ -0,0 +1,80 @@ + + + + + created + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/created
+
+

created

+
+
fun created(created: String)(source)
fun created(created: ZonedDateTime)(source)

ISO timestamp.

fun created(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/guid.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/guid.html new file mode 100644 index 0000000..faf0449 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/guid.html @@ -0,0 +1,80 @@ + + + + + guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/guid
+
+

guid

+
+
fun guid(guid: String)(source)
fun guid(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/index.html new file mode 100644 index 0000000..3fea2a2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/index.html @@ -0,0 +1,288 @@ + + + + + UpdateDeeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks
+
+

UpdateDeeplinks

+
class UpdateDeeplinks(source)

Configures deeplinks used when updating Bitlinks.

See the Bit.ly API for more information.

Since

2.0

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor()
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_guid(): String?
fun app_guid(app_guid: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun app_uri_path(): String?
fun app_uri_path(app_uri_path: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlink(): String?
fun bitlink(bitlink: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun brand_guid(): String?
fun brand_guid(brand_guid: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun created(): String?

fun created(created: ZonedDateTime)
fun created(created: String)

ISO timestamp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun guid(): String?
fun guid(guid: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_type(): InstallType?
fun install_type(install_type: InstallType)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun install_url(): String?
fun install_url(install_url: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun isNotEmpty(): Boolean

Returns true if there are defined links.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun links(): Map<String, String>

Returns the links.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun modified(): String?

fun modified(modified: ZonedDateTime)
fun modified(modified: String)

ISO timestamp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun os(): Os?
fun os(os: Os)
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/install_type.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/install_type.html new file mode 100644 index 0000000..ff99ad2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/install_type.html @@ -0,0 +1,80 @@ + + + + + install_type + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/install_type
+
+

install_type

+
+
fun install_type(install_type: InstallType)(source)
fun install_type(): InstallType?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/install_url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/install_url.html new file mode 100644 index 0000000..25119c5 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/install_url.html @@ -0,0 +1,80 @@ + + + + + install_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/install_url
+
+

install_url

+
+
fun install_url(install_url: String)(source)
fun install_url(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/is-not-empty.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/is-not-empty.html new file mode 100644 index 0000000..b1d15f8 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/is-not-empty.html @@ -0,0 +1,80 @@ + + + + + isNotEmpty + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/isNotEmpty
+
+

isNotEmpty

+
+
fun isNotEmpty(): Boolean(source)

Returns true if there are defined links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/links.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/links.html new file mode 100644 index 0000000..9b829a4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/links.html @@ -0,0 +1,80 @@ + + + + + links + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/links
+
+

links

+
+
fun links(): Map<String, String>(source)

Returns the links.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/modified.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/modified.html new file mode 100644 index 0000000..11a96b4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/modified.html @@ -0,0 +1,80 @@ + + + + + modified + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/modified
+
+

modified

+
+
fun modified(modified: String)(source)
fun modified(modified: ZonedDateTime)(source)

ISO timestamp.

fun modified(): String?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/os.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/os.html new file mode 100644 index 0000000..2d4a6e8 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/-update-deeplinks/os.html @@ -0,0 +1,80 @@ + + + + + os + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks/UpdateDeeplinks/os
+
+

os

+
+
fun os(os: Os)(source)
fun os(): Os?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/index.html new file mode 100644 index 0000000..5db556d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly.deeplinks/index.html @@ -0,0 +1,148 @@ + + + + + net.thauvin.erik.bitly.deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly.deeplinks
+
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
class CreateDeeplinks

Configures deeplinks used when creating Bitlinks.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum InstallType : Enum<InstallType>

Defines the installation types.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum Os : Enum<Os>

Defines the operating system types.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class UpdateDeeplinks

Configures deeplinks used when updating Bitlinks.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html new file mode 100644 index 0000000..a348a45 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html @@ -0,0 +1,80 @@ + + + + + Bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/Bitlinks
+
+

Bitlinks

+
+
constructor(accessToken: String)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html new file mode 100644 index 0000000..a54e966 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html @@ -0,0 +1,80 @@ + + + + + clicks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/clicks
+
+

clicks

+
+
fun clicks(bitlink: String, unit: Units = Units.DAY, units: Int = -1, unit_reference: String = Constants.EMPTY, toJson: Boolean = false): String(source)

Returns the click counts for a specified Bitlink.

See the Bitly API for more information.

Return

The click counts.

Parameters

bitlink

A Bitlink made of the domain and hash.

unit
units

An integer representing the time units to query data for. Pass -1 to return all units available.

unit_reference

An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

toJson

Returns the full JSON response if true.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/create.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/create.html new file mode 100644 index 0000000..988c9ee --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/create.html @@ -0,0 +1,80 @@ + + + + + create + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/create
+
+

create

+
+
fun create(config: CreateConfig): String(source)

Converts a long url to a Bitlink and sets additional parameters.

See the Bit.ly API for more information.

Return

The shortened URL or an empty string on error.

Parameters

config

The parameters' configuration.

fun create(long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, title: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: CreateDeeplinks = CreateDeeplinks(), toJson: Boolean = false): String(source)

Converts a long url to a Bitlink and sets additional parameters.

See the Bit.ly API for more information.

Return

The shortened URL or an empty string on error.

Parameters

long_url

The long URL.

domain

A branded short domain or bit.ly by default.

group_guid

A GUID for a Bitly group.

toJson

Returns the full JSON response if true.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/expand.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/expand.html new file mode 100644 index 0000000..bb05e3a --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/expand.html @@ -0,0 +1,80 @@ + + + + + expand + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/expand
+
+

expand

+
+
fun expand(bitlink_id: String, toJson: Boolean = false): String(source)

Expands a Bitlink.

See the Bit.ly API for more information.

Return

The long URL or an empty string on error.

Parameters

bitlink_id

The bitlink ID.

toJson

Returns the full JSON response if true.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/index.html new file mode 100644 index 0000000..ecfaf55 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/index.html @@ -0,0 +1,217 @@ + + + + + Bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks
+
+

Bitlinks

+
open class Bitlinks(accessToken: String)(source)

Provides functions to create and manage Bitlinks.

See the Bitly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(accessToken: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var lastCallResponse: CallResponse

The last API call response.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun clicks(bitlink: String, unit: Units = Units.DAY, units: Int = -1, unit_reference: String = Constants.EMPTY, toJson: Boolean = false): String

Returns the click counts for a specified Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun create(config: CreateConfig): String
fun create(long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, title: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: CreateDeeplinks = CreateDeeplinks(), toJson: Boolean = false): String

Converts a long url to a Bitlink and sets additional parameters.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun expand(bitlink_id: String, toJson: Boolean = false): String

Expands a Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun shorten(long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, toJson: Boolean = false): String

Shortens a long URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun update(config: UpdateConfig): String
fun update(bitlink: String, title: String = Constants.EMPTY, archived: Boolean = false, tags: Array<String> = emptyArray(), deeplinks: UpdateDeeplinks = UpdateDeeplinks(), toJson: Boolean = false): String

Updates parameters in the specified Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun updateCustom(custom_bitlink: String, bitlink_id: String, toJson: Boolean = false): String

Move a keyword (or custom back-half) to a different Bitlink (domains must match).

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html new file mode 100644 index 0000000..873b81e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html @@ -0,0 +1,80 @@ + + + + + lastCallResponse + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/lastCallResponse
+
+

lastCallResponse

+
+
var lastCallResponse: CallResponse(source)

The last API call response.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html new file mode 100644 index 0000000..5719b9f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html @@ -0,0 +1,80 @@ + + + + + shorten + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/shorten
+
+

shorten

+
+
fun shorten(long_url: String, domain: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, toJson: Boolean = false): String(source)

Shortens a long URL.

See the Bit.ly API for more information.

Return

The short URL or the long_url on error.

Parameters

long_url

The long URL.

domain

A branded short domain or bit.ly by default.

group_guid

A GUID for a Bitly group.

toJson

Returns the full JSON response if true.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update-custom.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update-custom.html new file mode 100644 index 0000000..bd2b683 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update-custom.html @@ -0,0 +1,80 @@ + + + + + updateCustom + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/updateCustom
+
+

updateCustom

+
+
fun updateCustom(custom_bitlink: String, bitlink_id: String, toJson: Boolean = false): String(source)

Move a keyword (or custom back-half) to a different Bitlink (domains must match).

See the Bit.ly API for more information.

Return

Constants.TRUE if the update was successful, Constants.FALSE otherwise.

Parameters

custom_bitlink

A Custom Bitlink made of the domain and keyword.

toJson

Returns the full JSON response if true.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update.html new file mode 100644 index 0000000..d6c63a1 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update.html @@ -0,0 +1,80 @@ + + + + + update + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitlinks/update
+
+

update

+
+
fun update(config: UpdateConfig): String(source)

Updates parameters in the specified Bitlink.

See the Bit.ly API for more information.

Return

Constants.TRUE if the update was successful, Constants.FALSE otherwise.

Parameters

config

The parameters' configuration.

fun update(bitlink: String, title: String = Constants.EMPTY, archived: Boolean = false, tags: Array<String> = emptyArray(), deeplinks: UpdateDeeplinks = UpdateDeeplinks(), toJson: Boolean = false): String(source)

Updates parameters in the specified Bitlink.

See the Bit.ly API for more information.

Return

Constants.TRUE if the update was successful, Constants.FALSE otherwise.

Parameters

bitlink

A Bitlink made of the domain and hash.

toJson

Returns the full JSON response if true.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html new file mode 100644 index 0000000..baf7fc4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html @@ -0,0 +1,80 @@ + + + + + Bitly + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitly/Bitly
+
+

Bitly

+
+
constructor(accessToken: String)(source)

Creates a new instance using an API Access Token.

Parameters

accessToken

The API access token.

constructor(properties: Properties, key: String = Constants.ENV_ACCESS_TOKEN)(source)

Creates a new instance using a properties and property key.

Parameters

properties

The properties containing the API Access Token.

key

The property key containing the API Access Token.

constructor(propertiesFilePath: Path, key: String = Constants.ENV_ACCESS_TOKEN)(source)

Creates a new instance using a properties file path and property key.

Parameters

propertiesFilePath

The file path of the properties containing the API Access Token.

key

The property key containing the API Access Token.

constructor(propertiesFile: File, key: String = Constants.ENV_ACCESS_TOKEN)(source)

Creates a new instance using a properties file and property key.

Parameters

propertiesFile

The properties file containing the API Access Token.

key

The property key containing the API Access Token.

constructor()(source)

Creates new instance.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/access-token.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/access-token.html new file mode 100644 index 0000000..2a3e1a7 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/access-token.html @@ -0,0 +1,80 @@ + + + + + accessToken + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitly/accessToken
+
+

accessToken

+
+
var accessToken: String(source)

The API access token.

See Generic Access Token or Authentication.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html new file mode 100644 index 0000000..da7e11e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html @@ -0,0 +1,80 @@ + + + + + bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitly/bitlinks
+
+

bitlinks

+
+
fun bitlinks(): Bitlinks(source)

Returns a new Bitlinks instance.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/call.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/call.html new file mode 100644 index 0000000..4abafae --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/call.html @@ -0,0 +1,80 @@ + + + + + call + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitly/call
+
+

call

+
+
fun call(endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse(source)

Executes an API call.

Return

A CallResponse object.

Parameters

endPoint

The REST endpoint path. (e.g. shorten, expand, etc.)

params

The request parameters key/value map.

method

The submission Method.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/index.html new file mode 100644 index 0000000..53bd2ab --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-bitly/index.html @@ -0,0 +1,157 @@ + + + + + Bitly + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Bitly
+
+

Bitly

+
open class Bitly(source)

Provides access to the Bitly API v4.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(accessToken: String)

Creates a new instance using an API Access Token.

constructor(properties: Properties, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties and property key.

constructor(propertiesFilePath: Path, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties file path and property key.

constructor(propertiesFile: File, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties file and property key.

constructor()

Creates new instance.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var accessToken: String

The API access token.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlinks(): Bitlinks

Returns a new Bitlinks instance.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun call(endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse

Executes an API call.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/-call-response.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/-call-response.html new file mode 100644 index 0000000..6e4321c --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/-call-response.html @@ -0,0 +1,80 @@ + + + + + CallResponse + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/CallResponse
+
+

CallResponse

+
+
constructor(body: String = Constants.EMPTY_JSON, message: String = "", description: String = "", statusCode: Int = -1)(source)

Parameters

body

The response body.

message

Bitly error message, if any.

description

Bitly error description, if any.

statusCode

HTTP status code,

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/body.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/body.html new file mode 100644 index 0000000..3a93770 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/body.html @@ -0,0 +1,80 @@ + + + + + body + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/body
+
+

body

+
+
val body: String(source)

Parameters

body

The response body.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/description.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/description.html new file mode 100644 index 0000000..4f280b9 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/description.html @@ -0,0 +1,80 @@ + + + + + description + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/description
+
+

description

+
+
val description: String(source)

Parameters

description

Bitly error description, if any.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/index.html new file mode 100644 index 0000000..2ade260 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/index.html @@ -0,0 +1,348 @@ + + + + + CallResponse + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse
+
+

CallResponse

+
data class CallResponse(val body: String = Constants.EMPTY_JSON, val message: String = "", val description: String = "", val statusCode: Int = -1)(source)

Provides a data class to hold the JSON response.

Parameters

body

The response body.

message

Bitly error message, if any.

description

Bitly error description, if any.

statusCode

HTTP status code,

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(body: String = Constants.EMPTY_JSON, message: String = "", description: String = "", statusCode: Int = -1)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val body: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val description: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isBadRequest: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isCreated: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isForbidden: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isGone: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isInternalError: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isNotFound: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isSuccessful: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isTooManyRequests: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isUpgradeRequired: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val message: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val statusCode: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html new file mode 100644 index 0000000..e2c6fa6 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html @@ -0,0 +1,80 @@ + + + + + isBadRequest + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isBadRequest
+
+

isBadRequest

+
+
val isBadRequest: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-created.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-created.html new file mode 100644 index 0000000..b14c680 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-created.html @@ -0,0 +1,80 @@ + + + + + isCreated + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isCreated
+
+

isCreated

+
+
val isCreated: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html new file mode 100644 index 0000000..15cfd45 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html @@ -0,0 +1,80 @@ + + + + + isExpectationFailed + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isExpectationFailed
+
+

isExpectationFailed

+
+
val isExpectationFailed: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html new file mode 100644 index 0000000..d3260fa --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html @@ -0,0 +1,80 @@ + + + + + isForbidden + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isForbidden
+
+

isForbidden

+
+
val isForbidden: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-gone.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-gone.html new file mode 100644 index 0000000..74ed927 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-gone.html @@ -0,0 +1,80 @@ + + + + + isGone + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isGone
+
+

isGone

+
+
val isGone: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html new file mode 100644 index 0000000..a703e63 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html @@ -0,0 +1,80 @@ + + + + + isInternalError + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isInternalError
+
+

isInternalError

+
+
val isInternalError: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html new file mode 100644 index 0000000..292b8ec --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html @@ -0,0 +1,80 @@ + + + + + isNotFound + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isNotFound
+
+

isNotFound

+
+
val isNotFound: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-successful.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-successful.html new file mode 100644 index 0000000..babd215 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-successful.html @@ -0,0 +1,80 @@ + + + + + isSuccessful + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isSuccessful
+
+

isSuccessful

+
+
val isSuccessful: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html new file mode 100644 index 0000000..8845027 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html @@ -0,0 +1,80 @@ + + + + + isTemporarilyUnavailable + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isTemporarilyUnavailable
+
+

isTemporarilyUnavailable

+
+
val isTemporarilyUnavailable: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html new file mode 100644 index 0000000..59d3e44 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html @@ -0,0 +1,80 @@ + + + + + isTooManyRequests + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isTooManyRequests
+
+

isTooManyRequests

+
+
val isTooManyRequests: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html new file mode 100644 index 0000000..4b1e688 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html @@ -0,0 +1,80 @@ + + + + + isUnprocessableEntity + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isUnprocessableEntity
+
+

isUnprocessableEntity

+
+
val isUnprocessableEntity: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html new file mode 100644 index 0000000..924436f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html @@ -0,0 +1,80 @@ + + + + + isUpgradeRequired + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/isUpgradeRequired
+
+

isUpgradeRequired

+
+
val isUpgradeRequired: Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/message.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/message.html new file mode 100644 index 0000000..32af462 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/message.html @@ -0,0 +1,80 @@ + + + + + message + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/message
+
+

message

+
+
val message: String(source)

Parameters

message

Bitly error message, if any.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/status-code.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/status-code.html new file mode 100644 index 0000000..aa57bf6 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-call-response/status-code.html @@ -0,0 +1,80 @@ + + + + + statusCode + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/CallResponse/statusCode
+
+

statusCode

+
+
val statusCode: Int(source)

Parameters

statusCode

HTTP status code,

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html new file mode 100644 index 0000000..51de55d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html @@ -0,0 +1,80 @@ + + + + + API_BASE_URL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/API_BASE_URL
+
+

API_BASE_URL

+
+
const val API_BASE_URL: String(source)

The Bitly API base URL.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html new file mode 100644 index 0000000..b58ef11 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html @@ -0,0 +1,80 @@ + + + + + EMPTY + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/EMPTY
+
+

EMPTY

+
+
const val EMPTY: String(source)

Empty String.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html new file mode 100644 index 0000000..9f048e7 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html @@ -0,0 +1,80 @@ + + + + + EMPTY_JSON + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/EMPTY_JSON
+
+

EMPTY_JSON

+
+
const val EMPTY_JSON: String(source)

Empty JSON Object.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html new file mode 100644 index 0000000..8cb01a3 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html @@ -0,0 +1,80 @@ + + + + + ENV_ACCESS_TOKEN + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/ENV_ACCESS_TOKEN
+
+

ENV_ACCESS_TOKEN

+
+
const val ENV_ACCESS_TOKEN: String(source)

The API access token environment variable.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html new file mode 100644 index 0000000..f95955f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html @@ -0,0 +1,80 @@ + + + + + FALSE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/FALSE
+
+

FALSE

+
+
const val FALSE: String(source)

False

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-i-s-o_-t-i-m-e-s-t-a-m-p.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-i-s-o_-t-i-m-e-s-t-a-m-p.html new file mode 100644 index 0000000..4edb7fb --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-i-s-o_-t-i-m-e-s-t-a-m-p.html @@ -0,0 +1,80 @@ + + + + + ISO_TIMESTAMP + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/ISO_TIMESTAMP
+
+

ISO_TIMESTAMP

+
+
val ISO_TIMESTAMP: DateTimeFormatter(source)

ISO Timestamp format

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html new file mode 100644 index 0000000..44cefa2 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html @@ -0,0 +1,80 @@ + + + + + TRUE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants/TRUE
+
+

TRUE

+
+
const val TRUE: String(source)

True

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/index.html new file mode 100644 index 0000000..053baf4 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-constants/index.html @@ -0,0 +1,194 @@ + + + + + Constants + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Constants
+
+

Constants

+
object Constants(source)

Provides the constants for this package.

+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val API_BASE_URL: String

The Bitly API base URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val EMPTY: String

Empty String.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val EMPTY_JSON: String

Empty JSON Object.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val ENV_ACCESS_TOKEN: String

The API access token environment variable.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val FALSE: String

False

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ISO_TIMESTAMP: DateTimeFormatter

ISO Timestamp format

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val TRUE: String

True

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html new file mode 100644 index 0000000..fa1608f --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html @@ -0,0 +1,119 @@ + + + + + DELETE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods/DELETE
+
+

DELETE

+
DELETE
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html new file mode 100644 index 0000000..65f65e6 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html @@ -0,0 +1,119 @@ + + + + + GET + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods/GET
+
+

GET

+
GET
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html new file mode 100644 index 0000000..a1b0d39 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html @@ -0,0 +1,119 @@ + + + + + PATCH + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods/PATCH
+
+

PATCH

+
PATCH
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html new file mode 100644 index 0000000..e169eda --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html @@ -0,0 +1,119 @@ + + + + + POST + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods/POST
+
+

POST

+
POST
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/index.html new file mode 100644 index 0000000..bcabaac --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/index.html @@ -0,0 +1,217 @@ + + + + + Methods + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods
+
+

Methods

+
enum Methods : Enum<Methods> (source)

Provides HTTP methods definitions.

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
DELETE
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
GET
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
PATCH
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
POST
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Methods

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Methods>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/value-of.html new file mode 100644 index 0000000..2767887 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Methods(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/values.html new file mode 100644 index 0000000..4e2630c --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-methods/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Methods/values
+
+

values

+
+
fun values(): Array<Methods>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html new file mode 100644 index 0000000..f31d287 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html @@ -0,0 +1,119 @@ + + + + + DAY + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/DAY
+
+

DAY

+
DAY
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html new file mode 100644 index 0000000..39c1d18 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html @@ -0,0 +1,119 @@ + + + + + HOUR + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/HOUR
+
+

HOUR

+
HOUR
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html new file mode 100644 index 0000000..e476859 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html @@ -0,0 +1,119 @@ + + + + + MINUTE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/MINUTE
+
+

MINUTE

+
MINUTE
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html new file mode 100644 index 0000000..e92207d --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html @@ -0,0 +1,119 @@ + + + + + MONTH + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/MONTH
+
+

MONTH

+
MONTH
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html new file mode 100644 index 0000000..2da3a2e --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html @@ -0,0 +1,119 @@ + + + + + WEEK + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/WEEK
+
+

WEEK

+
WEEK
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/index.html new file mode 100644 index 0000000..1957f3b --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/index.html @@ -0,0 +1,232 @@ + + + + + Units + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units
+
+

Units

+
enum Units : Enum<Units> (source)

Provides units of time definitions.

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
MINUTE
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
HOUR
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
DAY
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
WEEK
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
MONTH
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Units

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Units>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/value-of.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/value-of.html new file mode 100644 index 0000000..8a29602 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Units(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/values.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/values.html new file mode 100644 index 0000000..37d65dc --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-units/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Units/values
+
+

values

+
+
fun values(): Array<Units>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/call.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/call.html new file mode 100644 index 0000000..0b97aeb --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/call.html @@ -0,0 +1,80 @@ + + + + + call + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils/call
+
+

call

+
+
fun call(accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse(source)

Executes an API call.

Return

A CallResponse object.

Parameters

accessToken

The API access token.

endPoint

The REST endpoint URI. (eg. https://api-ssl.bitly.com/v4/shorten)

params

The request parameters key/value map.

method

The submission Method.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/index.html new file mode 100644 index 0000000..ee9dd84 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/index.html @@ -0,0 +1,183 @@ + + + + + Utils + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils
+
+

Utils

+
object Utils(source)

Provides useful generic functions.

+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val logger: Logger

The logger instance.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun call(accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse

Executes an API call.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Logger.isSevereLoggable(): Boolean

Determines if Level.SEVERE logging is enabled.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun String.isValidUrl(): Boolean

Validates a URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun String.removeHttp(): String

Removes http(s) scheme from string.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun String.toEndPoint(): String

Builds the full API endpoint URL using the Constants.API_BASE_URL.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html new file mode 100644 index 0000000..4c1e993 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html @@ -0,0 +1,80 @@ + + + + + isSevereLoggable + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils/isSevereLoggable
+
+

isSevereLoggable

+
+
fun Logger.isSevereLoggable(): Boolean(source)

Determines if Level.SEVERE logging is enabled.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html new file mode 100644 index 0000000..8fb79ff --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html @@ -0,0 +1,80 @@ + + + + + isValidUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils/isValidUrl
+
+

isValidUrl

+
+
fun String.isValidUrl(): Boolean(source)

Validates a URL.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/logger.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/logger.html new file mode 100644 index 0000000..67810da --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/logger.html @@ -0,0 +1,80 @@ + + + + + logger + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils/logger
+
+

logger

+
+
val logger: Logger(source)

The logger instance.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/remove-http.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/remove-http.html new file mode 100644 index 0000000..4236638 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/remove-http.html @@ -0,0 +1,80 @@ + + + + + removeHttp + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils/removeHttp
+
+

removeHttp

+
+
fun String.removeHttp(): String(source)

Removes http(s) scheme from string.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/to-end-point.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/to-end-point.html new file mode 100644 index 0000000..b8fdd73 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/-utils/to-end-point.html @@ -0,0 +1,80 @@ + + + + + toEndPoint + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly/Utils/toEndPoint
+
+

toEndPoint

+
+
fun String.toEndPoint(): String(source)

Builds the full API endpoint URL using the Constants.API_BASE_URL.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/net.thauvin.erik.bitly/index.html b/docs/-bitly -shorten/net.thauvin.erik.bitly/index.html new file mode 100644 index 0000000..1dc11a8 --- /dev/null +++ b/docs/-bitly -shorten/net.thauvin.erik.bitly/index.html @@ -0,0 +1,194 @@ + + + + + net.thauvin.erik.bitly + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly Shorten/net.thauvin.erik.bitly
+
+

Package-level declarations

+

Provides the classes necessary to access the Bitly API v4.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open class Bitlinks(accessToken: String)

Provides functions to create and manage Bitlinks.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open class Bitly

Provides access to the Bitly API v4.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class CallResponse(val body: String = Constants.EMPTY_JSON, val message: String = "", val description: String = "", val statusCode: Int = -1)

Provides a data class to hold the JSON response.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Constants

Provides the constants for this package.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum Methods : Enum<Methods>

Provides HTTP methods definitions.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum Units : Enum<Units>

Provides units of time definitions.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Utils

Provides useful generic functions.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly -shorten/package-list b/docs/-bitly -shorten/package-list new file mode 100644 index 0000000..13c9038 --- /dev/null +++ b/docs/-bitly -shorten/package-list @@ -0,0 +1,181 @@ +$dokka.format:html-v1 +$dokka.linkExtension:html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums////PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType.AUTO_INSTALL///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-a-u-t-o_-i-n-s-t-a-l-l/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType.NO_INSTALL///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-n-o_-i-n-s-t-a-l-l/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType.PROMOTE_INSTALL///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/-p-r-o-m-o-t-e_-i-n-s-t-a-l-l/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/type/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/type.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/valueOf/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/value-of.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/InstallType/values/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-install-type/values.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/Os.ANDROID///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-a-n-d-r-o-i-d/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/Os.IOS///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/-i-o-s/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/Os///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/Os/type/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/type.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/Os/valueOf/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/value-of.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks.enums/Os/values/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks.enums/-os/values.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks////PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/CreateDeeplinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/-create-deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/app_id/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_id.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/app_id/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_id.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/app_uri_path/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_uri_path.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/app_uri_path/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/app_uri_path.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/install_type/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_type.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/install_type/#net.thauvin.erik.bitly.config.deeplinks.enums.InstallType/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_type.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/install_url/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_url.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/install_url/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/install_url.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/isNotEmpty/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/is-not-empty.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/CreateDeeplinks/links/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-create-deeplinks/links.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/index.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/UpdateDeeplinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/-update-deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/app_guid/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_guid.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/app_guid/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_guid.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/app_uri_path/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_uri_path.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/app_uri_path/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/app_uri_path.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/bitlink/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/bitlink/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/brand_guid/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/brand_guid.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/brand_guid/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/brand_guid.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/created/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/created.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/created/#java.time.ZonedDateTime/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/created.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/created/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/created.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/guid/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/guid.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/guid/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/guid.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/install_type/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_type.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/install_type/#net.thauvin.erik.bitly.config.deeplinks.enums.InstallType/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_type.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/install_url/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_url.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/install_url/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/install_url.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/isNotEmpty/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/is-not-empty.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/links/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/links.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/modified/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/modified.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/modified/#java.time.ZonedDateTime/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/modified.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/modified/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/modified.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/os/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/os.html +$dokka.location:net.thauvin.erik.bitly.config.deeplinks/UpdateDeeplinks/os/#net.thauvin.erik.bitly.config.deeplinks.enums.Os/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config.deeplinks/-update-deeplinks/os.html +$dokka.location:net.thauvin.erik.bitly.config////PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/index.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/Builder/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/build/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/deeplinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/deeplinks/#net.thauvin.erik.bitly.config.deeplinks.CreateDeeplinks/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/domain/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/domain/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/groupGuid/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/group_guid/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group_guid.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/longUrl/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/long_url/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long_url.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/tags/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/tags/#kotlin.Array[kotlin.String]/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/title/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/title/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/toJson/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/toJson/#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/index.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/CreateConfig/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.Array[kotlin.String]#net.thauvin.erik.bitly.config.deeplinks.CreateDeeplinks#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-create-config.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/CreateConfig/#net.thauvin.erik.bitly.config.CreateConfig.Builder/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/-create-config.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/deeplinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/domain/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/domain.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/group_guid/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/long_url/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/tags/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/tags.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/title/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/title.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/toJson/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/Builder/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/archived/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/archived/#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/bitlink/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/bitlink/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/build/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/deeplinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/deeplinks/#net.thauvin.erik.bitly.config.deeplinks.UpdateDeeplinks/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/tags/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/tags/#kotlin.Array[kotlin.String]/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/title/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/title/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/toJson/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/toJson/#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/index.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/UpdateConfig/#kotlin.String#kotlin.String#kotlin.Boolean#kotlin.Array[kotlin.String]#net.thauvin.erik.bitly.config.deeplinks.UpdateDeeplinks#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-update-config.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/UpdateConfig/#net.thauvin.erik.bitly.config.UpdateConfig.Builder/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/-update-config.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/archived/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/archived.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/bitlink/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/deeplinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/tags/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/tags.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/title/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/title.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/toJson/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html +$dokka.location:net.thauvin.erik.bitly////PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/index.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/index.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/Bitlinks/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/clicks/#kotlin.String#net.thauvin.erik.bitly.Units#kotlin.Int#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/create/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.Array[kotlin.String]#net.thauvin.erik.bitly.config.deeplinks.CreateDeeplinks#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/create.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/create/#net.thauvin.erik.bitly.config.CreateConfig/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/create.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/expand/#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/expand.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/lastCallResponse/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/shorten/#kotlin.String#kotlin.String#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/update/#kotlin.String#kotlin.String#kotlin.Boolean#kotlin.Array[kotlin.String]#net.thauvin.erik.bitly.config.deeplinks.UpdateDeeplinks#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/update/#net.thauvin.erik.bitly.config.UpdateConfig/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/updateCustom/#kotlin.String#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitlinks/update-custom.html +$dokka.location:net.thauvin.erik.bitly/Bitly///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/index.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#java.io.File#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#java.nio.file.Path#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#java.util.Properties#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/accessToken/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/access-token.html +$dokka.location:net.thauvin.erik.bitly/Bitly/bitlinks/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html +$dokka.location:net.thauvin.erik.bitly/Bitly/call/#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.Any]#net.thauvin.erik.bitly.Methods/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-bitly/call.html +$dokka.location:net.thauvin.erik.bitly/CallResponse///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/index.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/CallResponse/#kotlin.String#kotlin.String#kotlin.String#kotlin.Int/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/-call-response.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/body/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/body.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/description/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/description.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isBadRequest/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isCreated/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-created.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isExpectationFailed/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isForbidden/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isGone/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-gone.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isInternalError/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isNotFound/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isSuccessful/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-successful.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isTemporarilyUnavailable/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isTooManyRequests/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isUnprocessableEntity/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isUpgradeRequired/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/message/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/message.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/statusCode/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-call-response/status-code.html +$dokka.location:net.thauvin.erik.bitly/Constants///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/index.html +$dokka.location:net.thauvin.erik.bitly/Constants/API_BASE_URL/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html +$dokka.location:net.thauvin.erik.bitly/Constants/EMPTY/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html +$dokka.location:net.thauvin.erik.bitly/Constants/EMPTY_JSON/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html +$dokka.location:net.thauvin.erik.bitly/Constants/ENV_ACCESS_TOKEN/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html +$dokka.location:net.thauvin.erik.bitly/Constants/FALSE/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html +$dokka.location:net.thauvin.erik.bitly/Constants/ISO_TIMESTAMP/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-i-s-o_-t-i-m-e-s-t-a-m-p.html +$dokka.location:net.thauvin.erik.bitly/Constants/TRUE/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html +$dokka.location:net.thauvin.erik.bitly/Methods.DELETE///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html +$dokka.location:net.thauvin.erik.bitly/Methods.GET///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html +$dokka.location:net.thauvin.erik.bitly/Methods.PATCH///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html +$dokka.location:net.thauvin.erik.bitly/Methods.POST///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html +$dokka.location:net.thauvin.erik.bitly/Methods///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-methods/index.html +$dokka.location:net.thauvin.erik.bitly/Methods/valueOf/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-methods/value-of.html +$dokka.location:net.thauvin.erik.bitly/Methods/values/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-methods/values.html +$dokka.location:net.thauvin.erik.bitly/Units.DAY///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html +$dokka.location:net.thauvin.erik.bitly/Units.HOUR///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html +$dokka.location:net.thauvin.erik.bitly/Units.MINUTE///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html +$dokka.location:net.thauvin.erik.bitly/Units.MONTH///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html +$dokka.location:net.thauvin.erik.bitly/Units.WEEK///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly -shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html +$dokka.location:net.thauvin.erik.bitly/Units///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-units/index.html +$dokka.location:net.thauvin.erik.bitly/Units/valueOf/#kotlin.String/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-units/value-of.html +$dokka.location:net.thauvin.erik.bitly/Units/values/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-units/values.html +$dokka.location:net.thauvin.erik.bitly/Utils///PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/index.html +$dokka.location:net.thauvin.erik.bitly/Utils/call/#kotlin.String#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.Any]#net.thauvin.erik.bitly.Methods/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/call.html +$dokka.location:net.thauvin.erik.bitly/Utils/isSevereLoggable/java.util.logging.Logger#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html +$dokka.location:net.thauvin.erik.bitly/Utils/isValidUrl/kotlin.String#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html +$dokka.location:net.thauvin.erik.bitly/Utils/logger/#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/logger.html +$dokka.location:net.thauvin.erik.bitly/Utils/removeHttp/kotlin.String#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/remove-http.html +$dokka.location:net.thauvin.erik.bitly/Utils/toEndPoint/kotlin.String#/PointingToDeclaration/-bitly -shorten/net.thauvin.erik.bitly/-utils/to-end-point.html +net.thauvin.erik.bitly +net.thauvin.erik.bitly.config +net.thauvin.erik.bitly.config.deeplinks +net.thauvin.erik.bitly.config.deeplinks.enums + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html new file mode 100644 index 0000000..375aeb5 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/Builder
+
+

Builder

+
+
constructor(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html new file mode 100644 index 0000000..153b52d --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/build
+
+

build

+
+
fun build(): CreateConfig(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html new file mode 100644 index 0000000..0ffdeaf --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html @@ -0,0 +1,80 @@ + + + + + deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/deeplinks
+
+

deeplinks

+
+
fun deeplinks(deeplinks: Array<Map<String, String>>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html new file mode 100644 index 0000000..3a53dfb --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html @@ -0,0 +1,80 @@ + + + + + domain + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/domain
+
+

domain

+
+
fun domain(domain: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html new file mode 100644 index 0000000..ff1e0db --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html @@ -0,0 +1,80 @@ + + + + + groupGuid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/groupGuid
+
+

groupGuid

+
+
fun groupGuid(group_guid: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html new file mode 100644 index 0000000..04dd916 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html @@ -0,0 +1,228 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder
+
+

Builder

+
data class Builder(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)(source)

Configures the creation parameters of a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): CreateConfig
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun deeplinks(deeplinks: Array<Map<String, String>>): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun domain(domain: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun groupGuid(group_guid: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun longUrl(long_url: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun tags(tags: Array<String>): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun title(title: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun toJson(toJson: Boolean): <Error class: unknown class>
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html new file mode 100644 index 0000000..cb9230b --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html @@ -0,0 +1,80 @@ + + + + + longUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/longUrl
+
+

longUrl

+
+
fun longUrl(long_url: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html new file mode 100644 index 0000000..2e20b29 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/tags
+
+

tags

+
+
fun tags(tags: Array<String>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html new file mode 100644 index 0000000..a239edf --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/title
+
+

title

+
+
fun title(title: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html new file mode 100644 index 0000000..9b10023 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/toJson
+
+

toJson

+
+
fun toJson(toJson: Boolean): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html new file mode 100644 index 0000000..ab80a1e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/deepLinks
+
+

deepLinks

+
+
val deepLinks: Array<Map<String, String>>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/domain.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/domain.html new file mode 100644 index 0000000..144ebec --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/domain.html @@ -0,0 +1,80 @@ + + + + + domain + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/domain
+
+

domain

+
+
val domain: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html new file mode 100644 index 0000000..24d9685 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html @@ -0,0 +1,80 @@ + + + + + group_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/group_guid
+
+

group_guid

+
+
val group_guid: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/index.html new file mode 100644 index 0000000..5fd550f --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/index.html @@ -0,0 +1,213 @@ + + + + + CreateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig
+
+

CreateConfig

+
class CreateConfig(source)

Provides a builder to create a Bitlink.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)

Configures the creation parameters of a Bitlink.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val deepLinks: Array<Map<String, String>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val domain: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val group_guid: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val long_url: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val toJson: Boolean
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html new file mode 100644 index 0000000..cce8395 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/long_url
+
+

long_url

+
+
val long_url: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/tags.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/tags.html new file mode 100644 index 0000000..c1cee16 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/tags
+
+

tags

+
+
val tags: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/title.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/title.html new file mode 100644 index 0000000..6901ff7 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/title
+
+

title

+
+
val title: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html new file mode 100644 index 0000000..015751e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/CreateConfig/toJson
+
+

toJson

+
+
val toJson: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html new file mode 100644 index 0000000..9520047 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/Builder
+
+

Builder

+
+
constructor(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html new file mode 100644 index 0000000..53fc6fe --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html @@ -0,0 +1,80 @@ + + + + + archived + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/archived
+
+

archived

+
+
fun archived(archived: Boolean): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html new file mode 100644 index 0000000..0ba31b6 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/bitlink
+
+

bitlink

+
+
fun bitlink(bitlink: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html new file mode 100644 index 0000000..defec9c --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/build
+
+

build

+
+
fun build(): UpdateConfig(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html new file mode 100644 index 0000000..e02a4e3 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html @@ -0,0 +1,80 @@ + + + + + clientId + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/clientId
+
+

clientId

+
+
fun clientId(clientId: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html new file mode 100644 index 0000000..7a28cc5 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html @@ -0,0 +1,80 @@ + + + + + createdAt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/createdAt
+
+

createdAt

+
+
fun createdAt(createdAt: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html new file mode 100644 index 0000000..e2edf69 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html @@ -0,0 +1,80 @@ + + + + + createdBy + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/createdBy
+
+

createdBy

+
+
fun createdBy(createdBy: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html new file mode 100644 index 0000000..5d8bff5 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html @@ -0,0 +1,80 @@ + + + + + customBitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/customBitlinks
+
+

customBitlinks

+
+
fun customBitlinks(customBitlinks: Array<String>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html new file mode 100644 index 0000000..69c6ee4 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/deepLinks
+
+

deepLinks

+
+
fun deepLinks(deepLinks: Array<Map<String, String>>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html new file mode 100644 index 0000000..12dd212 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html @@ -0,0 +1,80 @@ + + + + + id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/id
+
+

id

+
+
fun id(id: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html new file mode 100644 index 0000000..ed0bcaf --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html @@ -0,0 +1,333 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder
+
+

Builder

+
data class Builder(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)(source)

Configures the update parameters of a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun archived(archived: Boolean): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlink(bitlink: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): UpdateConfig
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun clientId(clientId: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun createdAt(createdAt: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun createdBy(createdBy: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun customBitlinks(customBitlinks: Array<String>): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun deepLinks(deepLinks: Array<Map<String, String>>): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun id(id: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun link(link: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun longUrl(longUrl: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun references(references: Map<String, String>): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun tags(tags: Array<String>): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun title(title: String): <Error class: unknown class>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun toJson(toJson: Boolean): <Error class: unknown class>
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html new file mode 100644 index 0000000..7156d97 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html @@ -0,0 +1,80 @@ + + + + + link + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/link
+
+

link

+
+
fun link(link: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html new file mode 100644 index 0000000..af20bd1 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html @@ -0,0 +1,80 @@ + + + + + longUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/longUrl
+
+

longUrl

+
+
fun longUrl(longUrl: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html new file mode 100644 index 0000000..b729a9e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html @@ -0,0 +1,80 @@ + + + + + references + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/references
+
+

references

+
+
fun references(references: Map<String, String>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html new file mode 100644 index 0000000..197549a --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/tags
+
+

tags

+
+
fun tags(tags: Array<String>): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html new file mode 100644 index 0000000..f97ebcd --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/title
+
+

title

+
+
fun title(title: String): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html new file mode 100644 index 0000000..bdeff36 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/toJson
+
+

toJson

+
+
fun toJson(toJson: Boolean): <Error class: unknown class>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/archived.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/archived.html new file mode 100644 index 0000000..41f7d0d --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/archived.html @@ -0,0 +1,80 @@ + + + + + archived + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/archived
+
+

archived

+
+
val archived: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html new file mode 100644 index 0000000..6d8e010 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/bitlink
+
+

bitlink

+
+
val bitlink: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html new file mode 100644 index 0000000..e1fbc6c --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html @@ -0,0 +1,80 @@ + + + + + client_id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/client_id
+
+

client_id

+
+
val client_id: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html new file mode 100644 index 0000000..283f988 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html @@ -0,0 +1,80 @@ + + + + + created_at + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/created_at
+
+

created_at

+
+
val created_at: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html new file mode 100644 index 0000000..0936bb5 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html @@ -0,0 +1,80 @@ + + + + + created_by + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/created_by
+
+

created_by

+
+
val created_by: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html new file mode 100644 index 0000000..d3faca5 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html @@ -0,0 +1,80 @@ + + + + + custom_bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/custom_bitlinks
+
+

custom_bitlinks

+
+
val custom_bitlinks: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html new file mode 100644 index 0000000..0190384 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/deepLinks
+
+

deepLinks

+
+
val deepLinks: Array<Map<String, String>>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/id.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/id.html new file mode 100644 index 0000000..6546a32 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/id.html @@ -0,0 +1,80 @@ + + + + + id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/id
+
+

id

+
+
val id: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/index.html new file mode 100644 index 0000000..cc7b9f2 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/index.html @@ -0,0 +1,318 @@ + + + + + UpdateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig
+
+

UpdateConfig

+
class UpdateConfig(source)

Provides a builder to update a Bitlink.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)

Configures the update parameters of a Bitlink.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val archived: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val bitlink: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val client_id: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val created_at: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val created_by: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val custom_bitlinks: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val deepLinks: Array<Map<String, String>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val id: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val link: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val long_url: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val references: Map<String, String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val toJson: Boolean
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/link.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/link.html new file mode 100644 index 0000000..8d38df7 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/link.html @@ -0,0 +1,80 @@ + + + + + link + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/link
+
+

link

+
+
val link: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html new file mode 100644 index 0000000..e0e87ee --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/long_url
+
+

long_url

+
+
val long_url: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/references.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/references.html new file mode 100644 index 0000000..bc3294b --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/references.html @@ -0,0 +1,80 @@ + + + + + references + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/references
+
+

references

+
+
val references: Map<String, String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/tags.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/tags.html new file mode 100644 index 0000000..4b0df85 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/tags
+
+

tags

+
+
val tags: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/title.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/title.html new file mode 100644 index 0000000..173db68 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/title
+
+

title

+
+
val title: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html new file mode 100644 index 0000000..ab48efe --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config/UpdateConfig/toJson
+
+

toJson

+
+
val toJson: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly.config/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/index.html new file mode 100644 index 0000000..438e714 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly.config/index.html @@ -0,0 +1,119 @@ + + + + + net.thauvin.erik.bitly.config + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly.config
+
+

Package-level declarations

+

Provides configuration builders.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
class CreateConfig

Provides a builder to create a Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class UpdateConfig

Provides a builder to update a Bitlink.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html new file mode 100644 index 0000000..8066dce --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html @@ -0,0 +1,80 @@ + + + + + Bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/Bitlinks
+
+

Bitlinks

+
+
constructor(accessToken: String)(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html new file mode 100644 index 0000000..daceb0a --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html @@ -0,0 +1,80 @@ + + + + + clicks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/clicks
+
+

clicks

+
+
fun clicks(bitlink: String, unit: Units = Units.DAY, units: Int = -1, size: Int = 50, unit_reference: String = Constants.EMPTY, toJson: Boolean = false): String(source)

Returns the click counts for a specified Bitlink.

See the Bitly API for more information.

Return

The click counts.

Parameters

bitlink

A Bitlink made of the domain and hash.

unit
units

An integer representing the time units to query data for. Pass -1 to return all units available.

size

The quantity of items to be be returned.

unit_reference

An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

toJson

Returns the full JSON response if true.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/create.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/create.html new file mode 100644 index 0000000..7fb86de --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/create.html @@ -0,0 +1,80 @@ + + + + + create + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/create
+
+

create

+
+
fun create(config: CreateConfig): String(source)

Converts a long url to a Bitlink and sets additional parameters.

See the Bit.ly API for more information.

Return

The shortened URL or an empty string on error.

Parameters

config

The parameters' configuration.

fun create(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String, toJson: Boolean = false): String(source)

Converts a long url to a Bitlink and sets additional parameters.

See the Bit.ly API for more information.

Return

The shortened URL or an empty string on error.

Parameters

domain

A branded short domain or bit.ly by default.

group_guid

A GUID for a Bitly group.

long_url

The long URL.

toJson

Returns the full JSON response if true.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/expand.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/expand.html new file mode 100644 index 0000000..6644ef9 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/expand.html @@ -0,0 +1,80 @@ + + + + + expand + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/expand
+
+

expand

+
+
fun expand(bitlink_id: String, toJson: Boolean = false): String(source)

Expands a Bitlink.

See the Bit.ly API for more information.

Return

The long URL or an empty string on error.

Parameters

bitlink_id

The bitlink ID.

toJson

Returns the full JSON response if true.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/index.html new file mode 100644 index 0000000..b540407 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/index.html @@ -0,0 +1,202 @@ + + + + + Bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks
+
+

Bitlinks

+
open class Bitlinks(accessToken: String)(source)

Provides functions to create and manage Bitlinks.

See the Bitly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(accessToken: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var lastCallResponse: CallResponse

The last API call response.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun clicks(bitlink: String, unit: Units = Units.DAY, units: Int = -1, size: Int = 50, unit_reference: String = Constants.EMPTY, toJson: Boolean = false): String

Returns the click counts for a specified Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun create(config: CreateConfig): String
fun create(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String, toJson: Boolean = false): String

Converts a long url to a Bitlink and sets additional parameters.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun expand(bitlink_id: String, toJson: Boolean = false): String

Expands a Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun shorten(long_url: String, group_guid: String = Constants.EMPTY, domain: String = Constants.EMPTY, toJson: Boolean = false): String

Shortens a long URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun update(config: UpdateConfig): String
fun update(bitlink: String, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false): String

Updates parameters in the specified Bitlink.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html new file mode 100644 index 0000000..0a0493b --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html @@ -0,0 +1,80 @@ + + + + + lastCallResponse + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/lastCallResponse
+
+

lastCallResponse

+
+
var lastCallResponse: CallResponse(source)

The last API call response.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html new file mode 100644 index 0000000..c834581 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html @@ -0,0 +1,80 @@ + + + + + shorten + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/shorten
+
+

shorten

+
+
fun shorten(long_url: String, group_guid: String = Constants.EMPTY, domain: String = Constants.EMPTY, toJson: Boolean = false): String(source)

Shortens a long URL.

See the Bit.ly API for more information.

Return

The short URL or the long_url on error.

Parameters

long_url

The long URL.

group_guid

A GUID for a Bitly group.

domain

A branded short domain or bit.ly by default.

toJson

Returns the full JSON response if true.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/update.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/update.html new file mode 100644 index 0000000..786d8e5 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/update.html @@ -0,0 +1,80 @@ + + + + + update + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitlinks/update
+
+

update

+
+
fun update(config: UpdateConfig): String(source)

Updates parameters in the specified Bitlink.

See the Bit.ly API for more information.

Return

Constants.TRUE if the update was successful, Constants.FALSE otherwise.

Parameters

config

The parameters' configuration.

fun update(bitlink: String, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false): String(source)

Updates parameters in the specified Bitlink.

See the Bit.ly API for more information.

Return

Constants.TRUE if the update was successful, Constants.FALSE otherwise.

Parameters

bitlink

A Bitlink made of the domain and hash.

toJson

Returns the full JSON response if true.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html new file mode 100644 index 0000000..2d13e66 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html @@ -0,0 +1,80 @@ + + + + + Bitly + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitly/Bitly
+
+

Bitly

+
+
constructor(accessToken: String)(source)

Creates a new instance using an API Access Token.

Parameters

accessToken

The API access token.

constructor(properties: Properties, key: String = Constants.ENV_ACCESS_TOKEN)(source)

Creates a new instance using a properties and property key.

Parameters

properties

The properties containing the API Access Token.

key

The property key containing the API Access Token.

constructor(propertiesFilePath: Path, key: String = Constants.ENV_ACCESS_TOKEN)(source)

Creates a new instance using a properties file path and property key.

Parameters

propertiesFilePath

The file path of the properties containing the API Access Token.

key

The property key containing the API Access Token.

constructor(propertiesFile: File, key: String = Constants.ENV_ACCESS_TOKEN)(source)

Creates a new instance using a properties file and property key.

Parameters

propertiesFile

The properties file containing the API Access Token.

key

The property key containing the API Access Token.

constructor()(source)

Creates new instance.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/access-token.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/access-token.html new file mode 100644 index 0000000..698121e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/access-token.html @@ -0,0 +1,80 @@ + + + + + accessToken + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitly/accessToken
+
+

accessToken

+
+
var accessToken: String(source)

The API access token.

See Generic Access Token or Authentication.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html new file mode 100644 index 0000000..fc040fe --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html @@ -0,0 +1,80 @@ + + + + + bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitly/bitlinks
+
+

bitlinks

+
+
fun bitlinks(): Bitlinks(source)

Returns a new Bitlinks instance.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/call.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/call.html new file mode 100644 index 0000000..728da27 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/call.html @@ -0,0 +1,80 @@ + + + + + call + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitly/call
+
+

call

+
+
fun call(endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse(source)

Executes an API call.

Return

A CallResponse object.

Parameters

endPoint

The REST endpoint path. (eg. shorten, expand, etc.)

params

The request parameters key/value map.

method

The submission Method.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/index.html new file mode 100644 index 0000000..3b8ad9e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-bitly/index.html @@ -0,0 +1,157 @@ + + + + + Bitly + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Bitly
+
+

Bitly

+
open class Bitly(source)

Provides access to the Bitly API v4.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(accessToken: String)

Creates a new instance using an API Access Token.

constructor(properties: Properties, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties and property key.

constructor(propertiesFilePath: Path, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties file path and property key.

constructor(propertiesFile: File, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties file and property key.

constructor()

Creates new instance.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var accessToken: String

The API access token.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlinks(): Bitlinks

Returns a new Bitlinks instance.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun call(endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse

Executes an API call.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/-call-response.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/-call-response.html new file mode 100644 index 0000000..c9ea1ef --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/-call-response.html @@ -0,0 +1,80 @@ + + + + + CallResponse + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/CallResponse
+
+

CallResponse

+
+
constructor(body: String = Constants.EMPTY_JSON, message: String = "", description: String = "", statusCode: Int = -1)(source)

Parameters

body

The response body.

message

Bitly error message, if any.

description

Bitly error description, if any.

statusCode

HTTP status code,

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/body.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/body.html new file mode 100644 index 0000000..251d0dc --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/body.html @@ -0,0 +1,80 @@ + + + + + body + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/body
+
+

body

+
+
val body: String(source)

Parameters

body

The response body.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/description.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/description.html new file mode 100644 index 0000000..3adc0d4 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/description.html @@ -0,0 +1,80 @@ + + + + + description + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/description
+
+

description

+
+
val description: String(source)

Parameters

description

Bitly error description, if any.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/index.html new file mode 100644 index 0000000..cdad4df --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/index.html @@ -0,0 +1,348 @@ + + + + + CallResponse + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse
+
+

CallResponse

+
data class CallResponse(val body: String = Constants.EMPTY_JSON, val message: String = "", val description: String = "", val statusCode: Int = -1)(source)

Provides a data class to hold the JSON response.

Parameters

body

The response body.

message

Bitly error message, if any.

description

Bitly error description, if any.

statusCode

HTTP status code,

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(body: String = Constants.EMPTY_JSON, message: String = "", description: String = "", statusCode: Int = -1)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val body: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val description: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isBadRequest: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isCreated: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isForbidden: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isGone: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isInternalError: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isNotFound: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isSuccessful: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isTooManyRequests: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val isUpgradeRequired: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val message: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val statusCode: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html new file mode 100644 index 0000000..2364ee8 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html @@ -0,0 +1,80 @@ + + + + + isBadRequest + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isBadRequest
+
+

isBadRequest

+
+
val isBadRequest: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-created.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-created.html new file mode 100644 index 0000000..ad25cf7 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-created.html @@ -0,0 +1,80 @@ + + + + + isCreated + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isCreated
+
+

isCreated

+
+
val isCreated: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html new file mode 100644 index 0000000..c487a75 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html @@ -0,0 +1,80 @@ + + + + + isExpectationFailed + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isExpectationFailed
+
+

isExpectationFailed

+
+
val isExpectationFailed: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html new file mode 100644 index 0000000..bb60c3e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html @@ -0,0 +1,80 @@ + + + + + isForbidden + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isForbidden
+
+

isForbidden

+
+
val isForbidden: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-gone.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-gone.html new file mode 100644 index 0000000..6884d80 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-gone.html @@ -0,0 +1,80 @@ + + + + + isGone + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isGone
+
+

isGone

+
+
val isGone: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html new file mode 100644 index 0000000..2746996 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html @@ -0,0 +1,80 @@ + + + + + isInternalError + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isInternalError
+
+

isInternalError

+
+
val isInternalError: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html new file mode 100644 index 0000000..615e27c --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html @@ -0,0 +1,80 @@ + + + + + isNotFound + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isNotFound
+
+

isNotFound

+
+
val isNotFound: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-successful.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-successful.html new file mode 100644 index 0000000..9874ba1 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-successful.html @@ -0,0 +1,80 @@ + + + + + isSuccessful + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isSuccessful
+
+

isSuccessful

+
+
val isSuccessful: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html new file mode 100644 index 0000000..fc673fc --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html @@ -0,0 +1,80 @@ + + + + + isTemporarilyUnavailable + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isTemporarilyUnavailable
+
+

isTemporarilyUnavailable

+
+
val isTemporarilyUnavailable: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html new file mode 100644 index 0000000..93b81bd --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html @@ -0,0 +1,80 @@ + + + + + isTooManyRequests + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isTooManyRequests
+
+

isTooManyRequests

+
+
val isTooManyRequests: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html new file mode 100644 index 0000000..eb43618 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html @@ -0,0 +1,80 @@ + + + + + isUnprocessableEntity + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isUnprocessableEntity
+
+

isUnprocessableEntity

+
+
val isUnprocessableEntity: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html new file mode 100644 index 0000000..e8880a3 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html @@ -0,0 +1,80 @@ + + + + + isUpgradeRequired + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/isUpgradeRequired
+
+

isUpgradeRequired

+
+
val isUpgradeRequired: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/message.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/message.html new file mode 100644 index 0000000..812660e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/message.html @@ -0,0 +1,80 @@ + + + + + message + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/message
+
+

message

+
+
val message: String(source)

Parameters

message

Bitly error message, if any.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/status-code.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/status-code.html new file mode 100644 index 0000000..ea64ee9 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-call-response/status-code.html @@ -0,0 +1,80 @@ + + + + + statusCode + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/CallResponse/statusCode
+
+

statusCode

+
+
val statusCode: Int(source)

Parameters

statusCode

HTTP status code,

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html new file mode 100644 index 0000000..8111232 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html @@ -0,0 +1,80 @@ + + + + + API_BASE_URL + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants/API_BASE_URL
+
+

API_BASE_URL

+
+
const val API_BASE_URL: String(source)

The Bitly API base URL.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html new file mode 100644 index 0000000..e0de891 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html @@ -0,0 +1,80 @@ + + + + + EMPTY + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants/EMPTY
+
+

EMPTY

+
+
const val EMPTY: String(source)

Empty String.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html new file mode 100644 index 0000000..9fc0981 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html @@ -0,0 +1,80 @@ + + + + + EMPTY_JSON + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants/EMPTY_JSON
+
+

EMPTY_JSON

+
+
const val EMPTY_JSON: String(source)

Empty JSON Object.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html new file mode 100644 index 0000000..6ef1a3e --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html @@ -0,0 +1,80 @@ + + + + + ENV_ACCESS_TOKEN + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants/ENV_ACCESS_TOKEN
+
+

ENV_ACCESS_TOKEN

+
+
const val ENV_ACCESS_TOKEN: String(source)

The API access token environment variable.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html new file mode 100644 index 0000000..b6ff652 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html @@ -0,0 +1,80 @@ + + + + + FALSE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants/FALSE
+
+

FALSE

+
+
const val FALSE: String(source)

False

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html new file mode 100644 index 0000000..7aacaf9 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html @@ -0,0 +1,80 @@ + + + + + TRUE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants/TRUE
+
+

TRUE

+
+
const val TRUE: String(source)

True

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/index.html new file mode 100644 index 0000000..54a976b --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-constants/index.html @@ -0,0 +1,179 @@ + + + + + Constants + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Constants
+
+

Constants

+
object Constants(source)

Provides the constants for this package.

+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val API_BASE_URL: String

The Bitly API base URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val EMPTY: String

Empty String.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val EMPTY_JSON: String

Empty JSON Object.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val ENV_ACCESS_TOKEN: String

The API access token environment variable.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val FALSE: String

False

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val TRUE: String

True

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html new file mode 100644 index 0000000..e5e7843 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html @@ -0,0 +1,119 @@ + + + + + DELETE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods/DELETE
+
+

DELETE

+
DELETE
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html new file mode 100644 index 0000000..f4f890f --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html @@ -0,0 +1,119 @@ + + + + + GET + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods/GET
+
+

GET

+
GET
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html new file mode 100644 index 0000000..241e3c0 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html @@ -0,0 +1,119 @@ + + + + + PATCH + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods/PATCH
+
+

PATCH

+
PATCH
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html new file mode 100644 index 0000000..b5be452 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html @@ -0,0 +1,119 @@ + + + + + POST + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods/POST
+
+

POST

+
POST
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/index.html new file mode 100644 index 0000000..ba30f73 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/index.html @@ -0,0 +1,217 @@ + + + + + Methods + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods
+
+

Methods

+
enum Methods : Enum<Methods> (source)

Provides HTTP methods definitions.

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
DELETE
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
GET
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
PATCH
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
POST
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Methods

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Methods>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/value-of.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/value-of.html new file mode 100644 index 0000000..5716c64 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Methods(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/values.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/values.html new file mode 100644 index 0000000..ca80b18 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-methods/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Methods/values
+
+

values

+
+
fun values(): Array<Methods>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html new file mode 100644 index 0000000..41d72ab --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html @@ -0,0 +1,119 @@ + + + + + DAY + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/DAY
+
+

DAY

+
DAY
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html new file mode 100644 index 0000000..52adf59 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html @@ -0,0 +1,119 @@ + + + + + HOUR + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/HOUR
+
+

HOUR

+
HOUR
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html new file mode 100644 index 0000000..53e95b6 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html @@ -0,0 +1,119 @@ + + + + + MINUTE + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/MINUTE
+
+

MINUTE

+
MINUTE
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html new file mode 100644 index 0000000..667862c --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html @@ -0,0 +1,119 @@ + + + + + MONTH + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/MONTH
+
+

MONTH

+
MONTH
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html new file mode 100644 index 0000000..f0d77cc --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html @@ -0,0 +1,119 @@ + + + + + WEEK + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/WEEK
+
+

WEEK

+
WEEK
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/index.html new file mode 100644 index 0000000..c9630ec --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/index.html @@ -0,0 +1,232 @@ + + + + + Units + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units
+
+

Units

+
enum Units : Enum<Units> (source)

Provides units of time definitions.

+
+
+
+
+
+

Entries

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
MINUTE
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
HOUR
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
DAY
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
WEEK
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
MONTH
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val name: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val ordinal: Int
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun valueOf(value: String): Units

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun values(): Array<Units>

Returns an array containing the constants of this enum type, in the order they're declared.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/value-of.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/value-of.html new file mode 100644 index 0000000..af0876f --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/value-of.html @@ -0,0 +1,80 @@ + + + + + valueOf + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/valueOf
+
+

valueOf

+
+
fun valueOf(value: String): Units(source)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/values.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/values.html new file mode 100644 index 0000000..5e90fdf --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-units/values.html @@ -0,0 +1,80 @@ + + + + + values + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Units/values
+
+

values

+
+
fun values(): Array<Units>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/call.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/call.html new file mode 100644 index 0000000..d681d52 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/call.html @@ -0,0 +1,80 @@ + + + + + call + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils/call
+
+

call

+
+
fun call(accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse(source)

Executes an API call.

Return

A CallResponse object.

Parameters

accessToken

The API access token.

endPoint

The REST endpoint URI. (eg. https://api-ssl.bitly.com/v4/shorten)

params

The request parameters key/value map.

method

The submission Method.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/index.html new file mode 100644 index 0000000..8a16452 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/index.html @@ -0,0 +1,183 @@ + + + + + Utils + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils
+
+

Utils

+
object Utils(source)

Provides useful generic functions.

+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val logger: Logger

The logger instance.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun call(accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse

Executes an API call.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Logger.isSevereLoggable(): Boolean

Determines if Level.SEVERE logging is enabled.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun String.isValidUrl(): Boolean

Validates a URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun String.removeHttp(): String

Removes http(s) scheme from string.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun String.toEndPoint(): String

Builds the full API endpoint URL using the Constants.API_BASE_URL.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html new file mode 100644 index 0000000..598ea0c --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html @@ -0,0 +1,80 @@ + + + + + isSevereLoggable + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils/isSevereLoggable
+
+

isSevereLoggable

+
+
fun Logger.isSevereLoggable(): Boolean(source)

Determines if Level.SEVERE logging is enabled.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html new file mode 100644 index 0000000..8dc9eac --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html @@ -0,0 +1,80 @@ + + + + + isValidUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils/isValidUrl
+
+

isValidUrl

+
+
fun String.isValidUrl(): Boolean(source)

Validates a URL.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/logger.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/logger.html new file mode 100644 index 0000000..bb25792 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/logger.html @@ -0,0 +1,80 @@ + + + + + logger + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils/logger
+
+

logger

+
+
val logger: Logger(source)

The logger instance.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/remove-http.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/remove-http.html new file mode 100644 index 0000000..1512368 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/remove-http.html @@ -0,0 +1,80 @@ + + + + + removeHttp + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils/removeHttp
+
+

removeHttp

+
+
fun String.removeHttp(): String(source)

Removes http(s) scheme from string.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/to-end-point.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/to-end-point.html new file mode 100644 index 0000000..e97bf58 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/-utils/to-end-point.html @@ -0,0 +1,80 @@ + + + + + toEndPoint + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly/Utils/toEndPoint
+
+

toEndPoint

+
+
fun String.toEndPoint(): String(source)

Builds the full API endpoint URL using the Constants.API_BASE_URL.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/net.thauvin.erik.bitly/index.html b/docs/-bitly--shorten/net.thauvin.erik.bitly/index.html new file mode 100644 index 0000000..0f3f9d3 --- /dev/null +++ b/docs/-bitly--shorten/net.thauvin.erik.bitly/index.html @@ -0,0 +1,194 @@ + + + + + net.thauvin.erik.bitly + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Bitly-Shorten/net.thauvin.erik.bitly
+
+

Package-level declarations

+

Provides the classes necessary to access the Bitly API v4.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open class Bitlinks(accessToken: String)

Provides functions to create and manage Bitlinks.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open class Bitly

Provides access to the Bitly API v4.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class CallResponse(val body: String = Constants.EMPTY_JSON, val message: String = "", val description: String = "", val statusCode: Int = -1)

Provides a data class to hold the JSON response.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Constants

Provides the constants for this package.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum Methods : Enum<Methods>

Provides HTTP methods definitions.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
enum Units : Enum<Units>

Provides units of time definitions.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
object Utils

Provides useful generic functions.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/-bitly--shorten/package-list b/docs/-bitly--shorten/package-list new file mode 100644 index 0000000..42f8c04 --- /dev/null +++ b/docs/-bitly--shorten/package-list @@ -0,0 +1,123 @@ +$dokka.format:html-v1 +$dokka.linkExtension:html +$dokka.location:net.thauvin.erik.bitly.config////PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/index.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/Builder/#kotlin.String#kotlin.String#kotlin.String#kotlin.Array[kotlin.String]#kotlin.Array[kotlin.collections.Map[kotlin.String,kotlin.String]]#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/build/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/deeplinks/#kotlin.Array[kotlin.collections.Map[kotlin.String,kotlin.String]]/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/domain/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/groupGuid/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/longUrl/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/tags/#kotlin.Array[kotlin.String]/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/title/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig.Builder/toJson/#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/index.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/deepLinks/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/domain/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/domain.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/group_guid/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/long_url/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/tags/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/tags.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/title/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/title.html +$dokka.location:net.thauvin.erik.bitly.config/CreateConfig/toJson/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/Builder/#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.String]#kotlin.Boolean#kotlin.Array[kotlin.String]#kotlin.String#kotlin.String#kotlin.Array[kotlin.collections.Map[kotlin.String,kotlin.String]]#kotlin.String#kotlin.String#kotlin.String#kotlin.Array[kotlin.String]#kotlin.String#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/archived/#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/bitlink/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/build/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/clientId/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/createdAt/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/createdBy/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/customBitlinks/#kotlin.Array[kotlin.String]/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/deepLinks/#kotlin.Array[kotlin.collections.Map[kotlin.String,kotlin.String]]/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/id/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/link/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/longUrl/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/references/#kotlin.collections.Map[kotlin.String,kotlin.String]/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/tags/#kotlin.Array[kotlin.String]/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/title/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig.Builder/toJson/#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/index.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/archived/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/archived.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/bitlink/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/client_id/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/created_at/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/created_by/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/custom_bitlinks/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/deepLinks/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/id/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/id.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/link/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/link.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/long_url/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/references/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/references.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/tags/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/tags.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/title/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/title.html +$dokka.location:net.thauvin.erik.bitly.config/UpdateConfig/toJson/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html +$dokka.location:net.thauvin.erik.bitly////PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/index.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/index.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/Bitlinks/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/clicks/#kotlin.String#net.thauvin.erik.bitly.Units#kotlin.Int#kotlin.Int#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/create/#kotlin.String#kotlin.String#kotlin.String#kotlin.Array[kotlin.String]#kotlin.Array[kotlin.collections.Map[kotlin.String,kotlin.String]]#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/create.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/create/#net.thauvin.erik.bitly.config.CreateConfig/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/create.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/expand/#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/expand.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/lastCallResponse/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/shorten/#kotlin.String#kotlin.String#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/update/#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.String]#kotlin.Boolean#kotlin.Array[kotlin.String]#kotlin.String#kotlin.String#kotlin.Array[kotlin.collections.Map[kotlin.String,kotlin.String]]#kotlin.String#kotlin.String#kotlin.String#kotlin.Array[kotlin.String]#kotlin.String#kotlin.String#kotlin.Boolean/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/update.html +$dokka.location:net.thauvin.erik.bitly/Bitlinks/update/#net.thauvin.erik.bitly.config.UpdateConfig/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitlinks/update.html +$dokka.location:net.thauvin.erik.bitly/Bitly///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/index.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#java.io.File#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#java.nio.file.Path#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#java.util.Properties#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/Bitly/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +$dokka.location:net.thauvin.erik.bitly/Bitly/accessToken/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/access-token.html +$dokka.location:net.thauvin.erik.bitly/Bitly/bitlinks/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html +$dokka.location:net.thauvin.erik.bitly/Bitly/call/#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.Any]#net.thauvin.erik.bitly.Methods/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-bitly/call.html +$dokka.location:net.thauvin.erik.bitly/CallResponse///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/index.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/CallResponse/#kotlin.String#kotlin.String#kotlin.String#kotlin.Int/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/-call-response.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/body/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/body.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/description/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/description.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isBadRequest/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-bad-request.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isCreated/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-created.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isExpectationFailed/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-expectation-failed.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isForbidden/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-forbidden.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isGone/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-gone.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isInternalError/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-internal-error.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isNotFound/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-not-found.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isSuccessful/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-successful.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isTemporarilyUnavailable/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-temporarily-unavailable.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isTooManyRequests/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-too-many-requests.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isUnprocessableEntity/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-unprocessable-entity.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/isUpgradeRequired/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/is-upgrade-required.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/message/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/message.html +$dokka.location:net.thauvin.erik.bitly/CallResponse/statusCode/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-call-response/status-code.html +$dokka.location:net.thauvin.erik.bitly/Constants///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/index.html +$dokka.location:net.thauvin.erik.bitly/Constants/API_BASE_URL/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/-a-p-i_-b-a-s-e_-u-r-l.html +$dokka.location:net.thauvin.erik.bitly/Constants/EMPTY/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y.html +$dokka.location:net.thauvin.erik.bitly/Constants/EMPTY_JSON/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-m-p-t-y_-j-s-o-n.html +$dokka.location:net.thauvin.erik.bitly/Constants/ENV_ACCESS_TOKEN/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html +$dokka.location:net.thauvin.erik.bitly/Constants/FALSE/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.html +$dokka.location:net.thauvin.erik.bitly/Constants/TRUE/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-constants/-t-r-u-e.html +$dokka.location:net.thauvin.erik.bitly/Methods.DELETE///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-methods/-d-e-l-e-t-e/index.html +$dokka.location:net.thauvin.erik.bitly/Methods.GET///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-methods/-g-e-t/index.html +$dokka.location:net.thauvin.erik.bitly/Methods.PATCH///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-a-t-c-h/index.html +$dokka.location:net.thauvin.erik.bitly/Methods.POST///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-methods/-p-o-s-t/index.html +$dokka.location:net.thauvin.erik.bitly/Methods///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-methods/index.html +$dokka.location:net.thauvin.erik.bitly/Methods/valueOf/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-methods/value-of.html +$dokka.location:net.thauvin.erik.bitly/Methods/values/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-methods/values.html +$dokka.location:net.thauvin.erik.bitly/Units.DAY///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-units/-d-a-y/index.html +$dokka.location:net.thauvin.erik.bitly/Units.HOUR///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-units/-h-o-u-r/index.html +$dokka.location:net.thauvin.erik.bitly/Units.MINUTE///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-units/-m-i-n-u-t-e/index.html +$dokka.location:net.thauvin.erik.bitly/Units.MONTH///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-units/-m-o-n-t-h/index.html +$dokka.location:net.thauvin.erik.bitly/Units.WEEK///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}-bitly--shorten/net.thauvin.erik.bitly/-units/-w-e-e-k/index.html +$dokka.location:net.thauvin.erik.bitly/Units///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-units/index.html +$dokka.location:net.thauvin.erik.bitly/Units/valueOf/#kotlin.String/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-units/value-of.html +$dokka.location:net.thauvin.erik.bitly/Units/values/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-units/values.html +$dokka.location:net.thauvin.erik.bitly/Utils///PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/index.html +$dokka.location:net.thauvin.erik.bitly/Utils/call/#kotlin.String#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.Any]#net.thauvin.erik.bitly.Methods/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/call.html +$dokka.location:net.thauvin.erik.bitly/Utils/isSevereLoggable/java.util.logging.Logger#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html +$dokka.location:net.thauvin.erik.bitly/Utils/isValidUrl/kotlin.String#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/is-valid-url.html +$dokka.location:net.thauvin.erik.bitly/Utils/logger/#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/logger.html +$dokka.location:net.thauvin.erik.bitly/Utils/removeHttp/kotlin.String#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/remove-http.html +$dokka.location:net.thauvin.erik.bitly/Utils/toEndPoint/kotlin.String#/PointingToDeclaration/-bitly--shorten/net.thauvin.erik.bitly/-utils/to-end-point.html +net.thauvin.erik.bitly +net.thauvin.erik.bitly.config + diff --git a/docs/alltypes/index.md b/docs/alltypes/index.md deleted file mode 100644 index 76ea730..0000000 --- a/docs/alltypes/index.md +++ /dev/null @@ -1,57 +0,0 @@ - - -[Bitly Shortener for Kotlin/Java](https://github.com/ethauvin/bitly-shorten) - -### All Types - -| Name | Summary | -|---|---| -| - -##### [net.thauvin.erik.bitly.Bitlinks](../net.thauvin.erik.bitly/-bitlinks/index.md) - -Provides functions to create and manage [Bitlinks](https://dev.bitly.com/v4/#tag/Bitlinks). - - -| - -##### [net.thauvin.erik.bitly.Bitly](../net.thauvin.erik.bitly/-bitly/index.md) - -Provides access to the [Bitly API v4](https://dev.bitly.com/v4). - - -| - -##### [net.thauvin.erik.bitly.CallResponse](../net.thauvin.erik.bitly/-call-response/index.md) - -Provides a data class to hold the JSON response. - - -| - -##### [net.thauvin.erik.bitly.Constants](../net.thauvin.erik.bitly/-constants/index.md) - -Provides the constants for this package. - - -| - -##### [net.thauvin.erik.bitly.Methods](../net.thauvin.erik.bitly/-methods/index.md) - -Provides HTTP methods definitions. - - -| - -##### [net.thauvin.erik.bitly.Units](../net.thauvin.erik.bitly/-units/index.md) - -Provides units of time definitions. - - -| - -##### [net.thauvin.erik.bitly.Utils](../net.thauvin.erik.bitly/-utils/index.md) - -Provides useful generic functions. - - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html new file mode 100644 index 0000000..9299f25 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/Builder
+
+

Builder

+
+
constructor(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html new file mode 100644 index 0000000..924e7aa --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/build
+
+

build

+
+
fun build(): CreateConfig(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html new file mode 100644 index 0000000..afefdd9 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/deeplinks.html @@ -0,0 +1,80 @@ + + + + + deeplinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/deeplinks
+
+

deeplinks

+
+
fun deeplinks(deeplinks: Array<Map<String, String>>): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html new file mode 100644 index 0000000..9c06d13 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/domain.html @@ -0,0 +1,80 @@ + + + + + domain + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/domain
+
+

domain

+
+
fun domain(domain: String): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html new file mode 100644 index 0000000..9341e11 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/group-guid.html @@ -0,0 +1,80 @@ + + + + + groupGuid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/groupGuid
+
+

groupGuid

+
+
fun groupGuid(group_guid: String): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html new file mode 100644 index 0000000..b827fe5 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/index.html @@ -0,0 +1,228 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder
+
+

Builder

+
data class Builder(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)(source)

Configures the creation parameters of a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): CreateConfig
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun deeplinks(deeplinks: Array<Map<String, String>>): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun domain(domain: String): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun groupGuid(group_guid: String): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun longUrl(long_url: String): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun tags(tags: Array<String>): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun title(title: String): CreateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun toJson(toJson: Boolean): CreateConfig.Builder
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html new file mode 100644 index 0000000..e699a4c --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/long-url.html @@ -0,0 +1,80 @@ + + + + + longUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/longUrl
+
+

longUrl

+
+
fun longUrl(long_url: String): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html new file mode 100644 index 0000000..daca9b0 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/tags
+
+

tags

+
+
fun tags(tags: Array<String>): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html new file mode 100644 index 0000000..b19ee22 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/title
+
+

title

+
+
fun title(title: String): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html new file mode 100644 index 0000000..97be5b8 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/Builder/toJson
+
+

toJson

+
+
fun toJson(toJson: Boolean): CreateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html new file mode 100644 index 0000000..3213539 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/deepLinks
+
+

deepLinks

+
+
val deepLinks: Array<Map<String, String>>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/domain.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/domain.html new file mode 100644 index 0000000..1a55cbe --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/domain.html @@ -0,0 +1,80 @@ + + + + + domain + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/domain
+
+

domain

+
+
val domain: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html new file mode 100644 index 0000000..dbc6973 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/group_guid.html @@ -0,0 +1,80 @@ + + + + + group_guid + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/group_guid
+
+

group_guid

+
+
val group_guid: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/index.html new file mode 100644 index 0000000..ebfd289 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/index.html @@ -0,0 +1,213 @@ + + + + + CreateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig
+
+

CreateConfig

+
class CreateConfig(source)

Provides a builder to create a Bitlink.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String = Constants.EMPTY, toJson: Boolean = false)

Configures the creation parameters of a Bitlink.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val deepLinks: Array<Map<String, String>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val domain: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val group_guid: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val long_url: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val toJson: Boolean
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html new file mode 100644 index 0000000..b83e786 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/long_url
+
+

long_url

+
+
val long_url: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/tags.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/tags.html new file mode 100644 index 0000000..6073a02 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/tags
+
+

tags

+
+
val tags: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/title.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/title.html new file mode 100644 index 0000000..236b069 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/title
+
+

title

+
+
val title: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html new file mode 100644 index 0000000..eafb57a --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/CreateConfig/toJson
+
+

toJson

+
+
val toJson: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html new file mode 100644 index 0000000..5503e8b --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/-builder.html @@ -0,0 +1,80 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/Builder
+
+

Builder

+
+
constructor(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html new file mode 100644 index 0000000..cb12aff --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/archived.html @@ -0,0 +1,80 @@ + + + + + archived + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/archived
+
+

archived

+
+
fun archived(archived: Boolean): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html new file mode 100644 index 0000000..7249f54 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/bitlink
+
+

bitlink

+
+
fun bitlink(bitlink: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html new file mode 100644 index 0000000..6d56a57 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/build.html @@ -0,0 +1,80 @@ + + + + + build + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/build
+
+

build

+
+
fun build(): UpdateConfig(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html new file mode 100644 index 0000000..01a4a12 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/client-id.html @@ -0,0 +1,80 @@ + + + + + clientId + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/clientId
+
+

clientId

+
+
fun clientId(clientId: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html new file mode 100644 index 0000000..c25c7cc --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-at.html @@ -0,0 +1,80 @@ + + + + + createdAt + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/createdAt
+
+

createdAt

+
+
fun createdAt(createdAt: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html new file mode 100644 index 0000000..da98157 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/created-by.html @@ -0,0 +1,80 @@ + + + + + createdBy + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/createdBy
+
+

createdBy

+
+
fun createdBy(createdBy: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html new file mode 100644 index 0000000..67b8fd7 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/custom-bitlinks.html @@ -0,0 +1,80 @@ + + + + + customBitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/customBitlinks
+
+

customBitlinks

+
+
fun customBitlinks(customBitlinks: Array<String>): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html new file mode 100644 index 0000000..dbb6b2c --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/deepLinks
+
+

deepLinks

+
+
fun deepLinks(deepLinks: Array<Map<String, String>>): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html new file mode 100644 index 0000000..1fa6d39 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/id.html @@ -0,0 +1,80 @@ + + + + + id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/id
+
+

id

+
+
fun id(id: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html new file mode 100644 index 0000000..45a529c --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/index.html @@ -0,0 +1,333 @@ + + + + + Builder + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder
+
+

Builder

+
data class Builder(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)(source)

Configures the update parameters of a Bitlink.

See the Bit.ly API for more information.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun archived(archived: Boolean): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlink(bitlink: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun build(): UpdateConfig
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun clientId(clientId: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun createdAt(createdAt: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun createdBy(createdBy: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun customBitlinks(customBitlinks: Array<String>): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun deepLinks(deepLinks: Array<Map<String, String>>): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun id(id: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun link(link: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun longUrl(longUrl: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun references(references: Map<String, String>): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun tags(tags: Array<String>): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun title(title: String): UpdateConfig.Builder
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun toJson(toJson: Boolean): UpdateConfig.Builder
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html new file mode 100644 index 0000000..9c046c4 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/link.html @@ -0,0 +1,80 @@ + + + + + link + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/link
+
+

link

+
+
fun link(link: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html new file mode 100644 index 0000000..3ee5dd9 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/long-url.html @@ -0,0 +1,80 @@ + + + + + longUrl + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/longUrl
+
+

longUrl

+
+
fun longUrl(longUrl: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html new file mode 100644 index 0000000..086a75a --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/references.html @@ -0,0 +1,80 @@ + + + + + references + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/references
+
+

references

+
+
fun references(references: Map<String, String>): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html new file mode 100644 index 0000000..e9378f9 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/tags
+
+

tags

+
+
fun tags(tags: Array<String>): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html new file mode 100644 index 0000000..654bb1f --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/title
+
+

title

+
+
fun title(title: String): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html new file mode 100644 index 0000000..7288ded --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/-builder/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/Builder/toJson
+
+

toJson

+
+
fun toJson(toJson: Boolean): UpdateConfig.Builder(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/archived.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/archived.html new file mode 100644 index 0000000..ed4df2c --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/archived.html @@ -0,0 +1,80 @@ + + + + + archived + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/archived
+
+

archived

+
+
val archived: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html new file mode 100644 index 0000000..db50a5b --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/bitlink.html @@ -0,0 +1,80 @@ + + + + + bitlink + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/bitlink
+
+

bitlink

+
+
val bitlink: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html new file mode 100644 index 0000000..35d0b9b --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/client_id.html @@ -0,0 +1,80 @@ + + + + + client_id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/client_id
+
+

client_id

+
+
val client_id: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html new file mode 100644 index 0000000..30c1980 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/created_at.html @@ -0,0 +1,80 @@ + + + + + created_at + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/created_at
+
+

created_at

+
+
val created_at: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html new file mode 100644 index 0000000..0c43294 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/created_by.html @@ -0,0 +1,80 @@ + + + + + created_by + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/created_by
+
+

created_by

+
+
val created_by: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html new file mode 100644 index 0000000..22273dc --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/custom_bitlinks.html @@ -0,0 +1,80 @@ + + + + + custom_bitlinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/custom_bitlinks
+
+

custom_bitlinks

+
+
val custom_bitlinks: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html new file mode 100644 index 0000000..c473d6f --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/deep-links.html @@ -0,0 +1,80 @@ + + + + + deepLinks + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/deepLinks
+
+

deepLinks

+
+
val deepLinks: Array<Map<String, String>>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/id.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/id.html new file mode 100644 index 0000000..ab103e6 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/id.html @@ -0,0 +1,80 @@ + + + + + id + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/id
+
+

id

+
+
val id: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/index.html new file mode 100644 index 0000000..15db502 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/index.html @@ -0,0 +1,318 @@ + + + + + UpdateConfig + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig
+
+

UpdateConfig

+
class UpdateConfig(source)

Provides a builder to update a Bitlink.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class Builder(bitlink: String = Constants.EMPTY, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false)

Configures the update parameters of a Bitlink.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val archived: Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val bitlink: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val client_id: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val created_at: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val created_by: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val custom_bitlinks: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val deepLinks: Array<Map<String, String>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val id: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val link: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val long_url: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val references: Map<String, String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val tags: Array<String>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val title: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val toJson: Boolean
+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/link.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/link.html new file mode 100644 index 0000000..8ae1fa0 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/link.html @@ -0,0 +1,80 @@ + + + + + link + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/link
+
+

link

+
+
val link: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html new file mode 100644 index 0000000..49b82b7 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/long_url.html @@ -0,0 +1,80 @@ + + + + + long_url + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/long_url
+
+

long_url

+
+
val long_url: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/references.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/references.html new file mode 100644 index 0000000..3ca936e --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/references.html @@ -0,0 +1,80 @@ + + + + + references + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/references
+
+

references

+
+
val references: Map<String, String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/tags.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/tags.html new file mode 100644 index 0000000..20d6553 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/tags.html @@ -0,0 +1,80 @@ + + + + + tags + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/tags
+
+

tags

+
+
val tags: Array<String>(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/title.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/title.html new file mode 100644 index 0000000..842e2c0 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/title.html @@ -0,0 +1,80 @@ + + + + + title + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/title
+
+

title

+
+
val title: String(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html new file mode 100644 index 0000000..48b4d7b --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-update-config/to-json.html @@ -0,0 +1,80 @@ + + + + + toJson + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config/UpdateConfig/toJson
+
+

toJson

+
+
val toJson: Boolean(source)
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/index.html new file mode 100644 index 0000000..62c3517 --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/index.html @@ -0,0 +1,119 @@ + + + + + net.thauvin.erik.bitly.config + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly.config
+
+

Package-level declarations

+

Provides configuration builders.

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
class CreateConfig

Provides a builder to create a Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class UpdateConfig

Provides a builder to update a Bitlink.

+
+
+
+
+
+
+
+
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html index 9a162a0..2cad864 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/-bitlinks.html @@ -1,38 +1,80 @@ - - + + + Bitlinks - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html index dac667c..6d3e25f 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/clicks.html @@ -1,38 +1,80 @@ - - + + + clicks - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/create.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/create.html index a210a08..66b0ba2 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/create.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/create.html @@ -1,38 +1,80 @@ - - + + + create - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/expand.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/expand.html index b540523..5a867bb 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/expand.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/expand.html @@ -1,38 +1,80 @@ - - + + + expand - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/index.html index f98a6ef..aff8831 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/index.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/index.html @@ -1,155 +1,202 @@ - - + + + Bitlinks - - -
-
- - -
-
-
-
-
-
- -

Properties

-
-
-
-
lastCallResponse -
Link copied to clipboard
-
-
-
-
var lastCallResponse: CallResponse
Content copied to clipboard
The last API call response.
-
-
-
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(accessToken: String)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var lastCallResponse: CallResponse

The last API call response.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Synchronized
@JvmOverloads
fun clicks(bitlink: String, unit: Units = Units.DAY, units: Int = -1, size: Int = 50, unit_reference: String = Constants.EMPTY, toJson: Boolean = false): String

Returns the click counts for a specified Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Synchronized
fun create(config: CreateConfig): String
@Synchronized
fun create(domain: String = Constants.EMPTY, title: String = Constants.EMPTY, group_guid: String = Constants.EMPTY, tags: Array<String> = emptyArray(), deeplinks: Array<Map<String, String>> = emptyArray(), long_url: String, toJson: Boolean = false): String

Converts a long url to a Bitlink and sets additional parameters.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Synchronized
@JvmOverloads
fun expand(bitlink_id: String, toJson: Boolean = false): String

Expands a Bitlink.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Synchronized
@JvmOverloads
fun shorten(long_url: String, group_guid: String = Constants.EMPTY, domain: String = Constants.EMPTY, toJson: Boolean = false): String

Shortens a long URL.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Synchronized
fun update(config: UpdateConfig): String
@Synchronized
fun update(bitlink: String, references: Map<String, String> = emptyMap(), archived: Boolean = false, tags: Array<String> = emptyArray(), created_at: String = Constants.EMPTY, title: String = Constants.EMPTY, deeplinks: Array<Map<String, String>> = emptyArray(), created_by: String = Constants.EMPTY, long_url: String = Constants.EMPTY, client_id: String = Constants.EMPTY, custom_bitlinks: Array<String> = emptyArray(), link: String = Constants.EMPTY, id: String = Constants.EMPTY, toJson: Boolean = false): String

Updates parameters in the specified Bitlink.

-
© 2021 CopyrightGenerated by dokka
- +
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html index fbb8223..165f471 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/last-call-response.html @@ -1,38 +1,80 @@ - - + + + lastCallResponse - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html index 45a8ae1..5646dfd 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/shorten.html @@ -1,38 +1,80 @@ - - + + + shorten - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/update.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/update.html index 4c75165..53b9ba1 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/update.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitlinks/update.html @@ -1,38 +1,80 @@ - - + + + update - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/-bitly.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/-bitly.html index 9c340a8..79dbb67 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/-bitly.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/-bitly.html @@ -1,62 +1,80 @@ - - + + + Bitly - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/access-token.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/access-token.html index 4afd993..947a0c1 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/access-token.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/access-token.html @@ -1,38 +1,80 @@ - - + + + accessToken - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html index 15f94a2..948a813 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/bitlinks.html @@ -1,38 +1,80 @@ - - + + + bitlinks - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/call.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/call.html index 351ed4d..8bc6900 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/call.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/call.html @@ -1,38 +1,80 @@ - - + + + call - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/index.html index 08ead36..7e2c38d 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/index.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-bitly/index.html @@ -1,156 +1,157 @@ - - + + + Bitly - - -
-
- - -
-
-
-
-
-
- -

Properties

-
-
-
-
accessToken -
Link copied to clipboard
-
-
-
-
var accessToken: String
Content copied to clipboard
The API access token.
-
-
-
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(accessToken: String)

Creates a new instance using an API Access Token.

@JvmOverloads
constructor(properties: Properties, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties and property key.

@JvmOverloads
constructor(propertiesFilePath: Path, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties file path and property key.

@JvmOverloads
constructor(propertiesFile: File, key: String = Constants.ENV_ACCESS_TOKEN)

Creates a new instance using a properties file and property key.

constructor()

Creates new instance.

+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var accessToken: String

The API access token.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun bitlinks(): Bitlinks

Returns a new Bitlinks instance.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@JvmOverloads
fun call(endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse

Executes an API call.

-
© 2021 CopyrightGenerated by dokka
- +
+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/-call-response.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/-call-response.html index 5d29d07..47e5238 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/-call-response.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/-call-response.html @@ -1,38 +1,80 @@ - - + + + CallResponse - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/body.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/body.html index 72dc1f1..c00edc2 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/body.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/body.html @@ -1,38 +1,80 @@ - - + + + body - - -
-
- - -
-
-
-
-
-
- + - diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/description.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/description.html new file mode 100644 index 0000000..4ad413f --- /dev/null +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/description.html @@ -0,0 +1,80 @@ + + + + + description + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
bitly-shorten/net.thauvin.erik.bitly/CallResponse/description
+
+

description

+
+
val description: String(source)

Parameters

description

Bitly error description, if any.

+
+
+ © 2023 CopyrightGenerated by dokka +
+
+
+
+ + diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/index.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/index.html index 6623de8..c00d49e 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/index.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-call-response/index.html @@ -1,94 +1,348 @@ - - + + + CallResponse - - -
-
- - -
-
-
-
-
-
-