publicapi.PublicApi.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bely-api Show documentation

null

There is a newer version: 0.0.4-dev-1

package com.elouyi.bely.publicapi

import com.elouyi.bely.publicapi.response.*
import com.elouyi.bely.utils.ElyLogger
import io.ktor.client.*
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Deferred

// TODO: 2021/6/5 加上 public 后缀，区分需要登录的 api

/**
 * Bilibili 无需登录的 API
 */
interface PublicApi : CoroutineScope {

    val logger: ElyLogger

    val client: HttpClient

    /// 视频信息

    /**
     * 异步获取视频信息
     * @param av 视频 av 号
     * @see VideoResponse
     * @see videoInfo
     */
    fun videoInfoAsync(av: Long): Deferred

    /**
     * 异步获取视频信息
     * @param  bv 视频 bv 号
     * @see VideoResponse
     * @see videoInfo
     */
    fun videoInfoAsync(bv: String): Deferred

    /**
     * 获取视频信息
     * @param av 视频 av 号
     * @see VideoResponse
     * @see videoInfoAsync
     */
    suspend fun videoInfo(av: Long): VideoResponse = videoInfoAsync(av).await()

    /**
     * 获取视频信息
     * @param  bv 视频 bv 号
     * @see VideoResponse
     * @see videoInfoAsync
     */
    suspend fun videoInfo(bv: String): VideoResponse = videoInfoAsync(bv).await()


    /// 用户关系

    /**
     * 异步获取用户关系信息
     * @param uid 用户 uid
     * @see RelationData
     * @see relation
     */
    fun relationAsync(uid: Long): Deferred

    /**
     * 获取用户关系信息
     * @param uid 用户 uid
     * @see RelationData
     * @see relationAsync
     */
    suspend fun relation(uid: Long): RelationResponse = relationAsync(uid).await()


    /// up主代表作


    /**
     * 异步获取 up主代表作
     * @param uid 用户 uid
     * @see VideoData
     * @see masterPiece
     */
    fun masterPieceAsync(uid: Long): Deferred

    /**
     * 获取 up主代表作
     * @param uid 用户 uid
     * @see VideoData
     * @see masterPieceAsync
     */
    suspend fun masterPiece(uid: Long): MasterPieceResponse = masterPieceAsync(uid).await()

    fun accInfoAsync(uid: Long): Deferred

    suspend fun accInfo(uid: Long): AccInfoResponse = accInfoAsync(uid).await()

}