data class GetGroupInfoResult @ApiResultConstructor constructor(val groupId: LongID, val groupName: String, val memberCount: Int, val maxMemberCount: Int)

GetGroupInfoApi 的响应体。

GetGroupListApi

class GetGroupListApi : OneBotApi<List<GetGroupInfoResult>>

get_group_list-获取群列表

GetGroupMemberInfoApi

class GetGroupMemberInfoApi : OneBotApi<GetGroupMemberInfoResult>

get_group_member_info-获取群成员信息

GetGroupMemberInfoResult

@Serializable

data class GetGroupMemberInfoResult @ApiResultConstructor constructor(val groupId: LongID, val userId: LongID, val nickname: String, val card: String = "", val sex: String = "unknown", val age: Int = -1, val area: String = "", val joinTime: Int = -1, val lastSentTime: Int = -1, val level: String = "", val role: String = "member", val unfriendly: Boolean = false, val title: String = "", val titleExpireTime: Int = -1, val cardChangeable: Boolean = false)

GetGroupMemberInfoApi 的响应体。

GetGroupMemberListApi

class GetGroupMemberListApi : OneBotApi<List<GetGroupMemberInfoResult>>

get_group_member_list-获取群成员列表

GetImageApi

class GetImageApi : OneBotApi<GetImageResult>

get_image-获取图片

GetImageResult

@Serializable

data class GetImageResult @ApiResultConstructor constructor(val file: String)

GetImageApi 的响应体。

GetLoginInfoApi

class GetLoginInfoApi : OneBotApi<GetLoginInfoResult>

get_login_info-获取登录号信息

GetLoginInfoResult

@Serializable

data class GetLoginInfoResult @ApiResultConstructor constructor(val userId: LongID, val nickname: String)

GetLoginInfoApi 的响应体。

GetMsgApi

class GetMsgApi : OneBotApi<GetMsgResult>

get_msg-获取消息

GetMsgResult

@Serializable

data class GetMsgResult @ApiResultConstructor constructor(val time: Int, val messageType: String, val messageId: IntID, val realId: IntID, val sender: JsonObject, val message: List<OneBotMessageSegment> = emptyList())

GetMsgApi 的响应体。

GetRecordApi

class GetRecordApi : OneBotApi<GetRecordResult>

get_record-获取语音

GetRecordResult

@Serializable

data class GetRecordResult @ApiResultConstructor constructor(val file: String)

GetRecordApi 的响应体。

GetStatusApi

class GetStatusApi : OneBotApi<StatusResult>

get_status-获取运行状态

GetStrangerInfoApi

class GetStrangerInfoApi : OneBotApi<GetStrangerInfoResult>

get_stranger_info-获取陌生人信息

GetStrangerInfoResult

@Serializable

data class GetStrangerInfoResult @ApiResultConstructor constructor(val userId: LongID, val nickname: String, val sex: String, val age: Int)

GetStrangerInfoApi 的响应体。

GetVersionInfoApi

class GetVersionInfoApi : OneBotApi<GetVersionInfoResult>

get_version_info-获取版本信息

GetVersionInfoResult

@Serializable

data class GetVersionInfoResult @ApiResultConstructor constructor(val appName: String, val appVersion: String, val protocolVersion: String)

GetVersionInfoApi 的响应体。

GlobalOneBotApiRequestConfiguration

@ExperimentalOneBotAPI

object GlobalOneBotApiRequestConfiguration

全局性的配置属性。

OneBotApi

interface OneBotApi<T : Any> : BasicOneBotApi<T>

针对一个 OneBot API 的定义实现，在 BasicOneBotApi 的基础上，使用基于 kotlinx-serialization 的反序列化器来实现 deserialize。

OneBotApiException

open class OneBotApiException : RuntimeException

与 OneBot 的 Api 相关的异常。

OneBotApiExecutable

interface OneBotApiExecutable

可以用于执行 BasicOneBotApi 的执行器接口描述。

OneBotApiExecutableScope

@JvmInline

value class OneBotApiExecutableScope(executable: OneBotApiExecutable)

在 OneBotApiExecutable 的基础上提供更多作用域API，允许在 Kotlin 中使用DSL的风格请求API。

OneBotApiResponseNotSuccessException

open class OneBotApiResponseNotSuccessException(val status: HttpStatusCode, message: String? = "status: ", cause: Throwable? = null) : OneBotApiException

OneBotApi 请求的响应结果状态码不是成功状态 (即不是2xx)

OneBotApiResult

@Serializable

data class OneBotApiResult<T : Any>(val retcode: Int, val status: String? = null, val data: T? = null)

响应

OneBotMessageOutgoing

@Serializable(with = OneBotMessageOutgoingSerializer::class)

sealed class OneBotMessageOutgoing

代表一个用于OneBot API中作为 message 发送的消息内容。它是一个仅用于序列化的类型。

OneBotMessageOutgoingSerializer

object OneBotMessageOutgoingSerializer : KSerializer<OneBotMessageOutgoing>

OneBotMessageOutgoing 的序列化器实现。仅保证序列化，反序列化很可能会产生异常，且尽可能避免使用。

SendGroupMsgApi

class SendGroupMsgApi : OneBotApi<SendMsgResult>

send_group_msg-发送群消息

SendLikeApi

class SendLikeApi : OneBotApi<Unit>

send_like-发送好友赞

SendMsgApi

class SendMsgApi : OneBotApi<SendMsgResult>

send_msg-发送消息

SendMsgResult

@Serializable

data class SendMsgResult @ApiResultConstructor constructor(val messageId: IntID)

SendMsgApi 的响应体。

SendPrivateMsgApi

class SendPrivateMsgApi : OneBotApi<SendMsgResult>

send_private_msg-发送私聊消息

SetFriendAddRequestApi

class SetFriendAddRequestApi : OneBotApi<Unit>

set_friend_add_request-处理加好友请求

SetGroupAddRequestApi

class SetGroupAddRequestApi : OneBotApi<Unit>

set_group_add_request-处理加群请求／邀请

SetGroupAdminApi

class SetGroupAdminApi : OneBotApi<Unit>

set_group_admin-群组设置管理员

SetGroupAnonymousApi

class SetGroupAnonymousApi : OneBotApi<Unit>

set_group_anonymous-群组匿名

SetGroupAnonymousBanApi

class SetGroupAnonymousBanApi : OneBotApi<Unit>

set_group_anonymous_ban-群组匿名用户禁言

SetGroupBanApi

class SetGroupBanApi : OneBotApi<Unit>

set_group_ban-群组单人禁言

SetGroupCardApi

class SetGroupCardApi : OneBotApi<Unit>

set_group_card-设置群名片（群备注）

SetGroupKickApi

class SetGroupKickApi : OneBotApi<Unit>

set_group_kick-群组踢人

SetGroupLeaveApi

class SetGroupLeaveApi : OneBotApi<Unit>

set_group_leave-退出群组

SetGroupNameApi

class SetGroupNameApi : OneBotApi<Unit>

set_group_name-设置群名

SetGroupSpecialTitleApi

class SetGroupSpecialTitleApi : OneBotApi<Unit>

set_group_special_title-设置群组专属头衔

SetGroupWholeBanApi

class SetGroupWholeBanApi : OneBotApi<Unit>

set_group_whole_ban-群组全员禁言

SetRestartApi

class SetRestartApi : OneBotApi<Unit>

set_restart-重启 OneBot 实现

Properties

ApiLogger

@InternalOneBotAPI

val ApiLogger: Logger

用于在对 BasicOneBotApi 发起请求时或得到想用后输出相关日志日志收集器。

Functions

CustomOneBotApi

inline fun <T : Any> CustomOneBotApi(action: String, method: HttpMethod = HttpMethod.Post, block: CustomOneBotApiBuilder<T>.() -> Unit): CustomOneBotApi<T>

CustomOneBotApi DSL builder function.

withExecutableScope

inline fun <T> withExecutableScope(executable: OneBotApiExecutable, action: OneBotApiExecutableScope.() -> T): T

在 OneBotApiExecutableScope 的作用域下执行 action。

Inherited functions

dataDeserializer

fun <T : Any> CustomOneBotApiBuilder<T>.dataDeserializer(dataDeserializer: KSerializer<T>): CustomOneBotApiBuilder<T>

提供一个 OneBotApiResult.data 的类型 T 的序列化器，来作为 CustomOneBotApiBuilder 的反序列化方案。

execute

inline suspend fun OneBotApiExecutable.execute(action: String, method: HttpMethod = HttpMethod.Post, body: Any? = null, block: CustomOneBotApiBuilder<*>.() -> Unit = {}): HttpResponse

基于 CustomOneBotApi 直接构建一个 Api 并发起请求。

executeData

inline suspend fun <T : Any> OneBotApiExecutable.executeData(action: String, method: HttpMethod = HttpMethod.Post, body: Any? = null, block: CustomOneBotApiBuilder<T>.() -> Unit): T

inline suspend fun <T : Any> OneBotApiExecutable.executeData(action: String, dataSerializer: KSerializer<T>, method: HttpMethod = HttpMethod.Post, body: Any? = null, block: CustomOneBotApiBuilder<T>.() -> Unit = {}): T

基于 CustomOneBotApi 直接构建一个 Api 并发起请求，得到对应的 OneBotApiResult。

executeResult

inline suspend fun <T : Any> OneBotApiExecutable.executeResult(action: String, method: HttpMethod = HttpMethod.Post, body: Any? = null, block: CustomOneBotApiBuilder<T>.() -> Unit): OneBotApiResult<T>

基于 CustomOneBotApi 直接构建一个 Api 并发起请求，得到对应的 OneBotApiResult。

inExecutableScope

inline fun <T> OneBotApiExecutable.inExecutableScope(action: OneBotApiExecutableScope.() -> T): T

在 OneBotApiExecutableScope 的作用域下执行 action。

request

suspend fun BasicOneBotApi<*>.request(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse

suspend fun BasicOneBotApi<*>.request(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse

对 this 发起一次请求，并得到相应的 HttpResponse 响应。

requestAsync

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): CompletableFuture<out HttpResponse>

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): CompletableFuture<out HttpResponse>

异步地请求 BasicOneBotApi.

requestBlocking

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse

阻塞地请求 BasicOneBotApi.

requestData

suspend fun <T : Any> BasicOneBotApi<T>.requestData(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

对 this 发起一次请求，并得到响应体的 T 类型结果。

suspend fun <T : Any> BasicOneBotApi<T>.requestData(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

对 this 发起一次请求，并得到响应体的 T 结果。

requestDataAsync

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestDataAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out T>

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestDataAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out T>

异步地请求 BasicOneBotApi.

requestDataBlocking

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestDataBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestDataBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

阻塞地请求 BasicOneBotApi.

requestDataReserve

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestDataReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<T>

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestDataReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<T>

异步地请求 BasicOneBotApi.

requestRaw

suspend fun BasicOneBotApi<*>.requestRaw(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String

suspend fun BasicOneBotApi<*>.requestRaw(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String

对 this 发起一次请求，并得到响应体的字符串内容。

requestRawAsync

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestRawAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): CompletableFuture<out String>

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestRawAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): CompletableFuture<out String>

异步地请求 BasicOneBotApi.

requestRawBlocking

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestRawBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestRawBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String

阻塞地请求 BasicOneBotApi.

requestRawReserve

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestRawReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): SuspendReserve<String>

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestRawReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): SuspendReserve<String>

异步地请求 BasicOneBotApi.

requestReserve

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

@Api4J

@JvmOverloads

fun BasicOneBotApi<*>.requestReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

异步地请求 BasicOneBotApi.

requestResult

suspend fun <T : Any> BasicOneBotApi<T>.requestResult(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>

suspend fun <T : Any> BasicOneBotApi<T>.requestResult(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>

对 this 发起一次请求，并得到响应体的 OneBotApiResult 结果。

requestResultAsync

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestResultAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out OneBotApiResult<T>>

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestResultAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out OneBotApiResult<T>>

异步地请求 BasicOneBotApi.

requestResultBlocking

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestResultBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestResultBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>

阻塞地请求 BasicOneBotApi.

requestResultReserve

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestResultReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<OneBotApiResult<T>>

@Api4J

@JvmOverloads

fun <T : Any> BasicOneBotApi<T>.requestResultReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<OneBotApiResult<T>>

异步地请求 BasicOneBotApi.

resolveUrl

fun BasicOneBotApi<*>.resolveUrl(urlBuilder: URLBuilder, actionSuffixes: Collection<String>?)

使用 OneBotApi.resolveUrlAction 和 OneBotApi.resolveUrlExtensions 。