io.v47.tmdb.StandaloneTmdbClient.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of standalone Show documentation

Standalone TMDb API client package for framework-less access to TMDb

There is a newer version: 5.0.0

/**
 * The Clear BSD License
 *
 * Copyright (c) 2023, the tmdb-api-client authors
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the disclaimer
 * below) provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *      * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 *      * Neither the name of the copyright holder nor the names of its
 *      contributors may be used to endorse or promote products derived from this
 *      software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
 * THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package io.v47.tmdb

import io.v47.tmdb.api.key.TmdbApiKeyProvider
import io.v47.tmdb.http.Java11HttpClientFactory

/**
 * A factory used to create [TmdbClient] instances that don't require any surrounding framework.
 */
object StandaloneTmdbClient {
    /**
     * Creates a new [TmdbClient] that authenticates all requests using the provided API key.
     *
     * @param apiKey TMDb API key
     */
    @JvmStatic
    @JvmName("WithApiKey")
    operator fun invoke(apiKey: String): TmdbClient {
        return TmdbClient(Java11HttpClientFactory(), apiKey)
    }

    /**
     * Creates a new [TmdbClient] that authenticates all requests using the API key provided by the
     * specified [TmdbApiKeyProvider].
     *
     * @param apiKeyProvider providing an API key
     */
    @JvmStatic
    @JvmName("WithApiKeyProvider")
    operator fun invoke(apiKeyProvider: TmdbApiKeyProvider): TmdbClient {
        return TmdbClient(Java11HttpClientFactory(), apiKeyProvider)
    }
}