simbot-component-qq-guild-api/love.forte.simbot.qguild.api/ApiDescription

ApiDescription

interface ApiDescription(source)

对一个 API 类型的描述，属性格式与接口权限对象中的相关信息保持一致。

ApiDescription 主要实现于 QQGuildApi 实现类型的伴生对象上。

可以通过 eq 来判断两个 ApiDescription 中的基本属性是否相同。

Author

ForteScarlet

Inheritors

SimpleApiDescription

Functions

infix fun ApiDescription.eq(other: ApiDescription): Boolean

用于判断两个 ApiDescription 中的两个属性是否相同。

@JvmName(name = "of")

fun ApiDescription.toIdentify(): ApiPermissionDemandIdentify

通过 ApiPermission 构建一个 ApiPermissionDemandIdentify.

Properties

abstract val method: String

请求方法，例如 GET（全大写）

abstract val path: String

API 接口名，例如 /guilds/{guild_id}/members/{user_id}