onebot-v11-lib/cn.qfys521.onebot.v11.lib.api/OneBotV11Client

OneBotV11Client

interface OneBotV11Client

Core OneBot V11 client abstraction.

Inheritors

DefaultOneBotV11Client

Properties

abstract val events: Flow<OneBotV11Event>

Stream of typed OneBot V11 events decoded from transport incoming payloads.

abstract val isStarted: Boolean

Whether underlying transport lifecycle has started.

Functions

abstract suspend fun <T> call(action: String, params: JsonObject, serializer: KSerializer<T>): ApiResponse<T>

Calls a OneBot action and decodes the data field with serializer.

abstract suspend fun close()

Releases transport resources.

abstract suspend fun deleteMessage(messageId: Long): ApiResponse<JsonObject>

Calls delete_msg.

abstract suspend fun getLoginInfo(): ApiResponse<LoginInfo>

Calls get_login_info.

listenEventsAnnotated

fun OneBotV11Client.listenEventsAnnotated(listener: Any, scope: CoroutineScope, onHandlerError: (Throwable, OneBotV11Event) -> Unit = { error, _ -> throw error }): Job

Subscribes to OneBotV11Client.events and dispatches each event to methods annotated with Event.

sendGroupMessage

abstract suspend fun sendGroupMessage(request: SendGroupMessageRequest): ApiResponse<SendMessageResult>

Calls send_group_msg.

sendPrivateMessage

abstract suspend fun sendPrivateMessage(request: SendPrivateMessageRequest): ApiResponse<SendMessageResult>

Calls send_private_msg.

abstract suspend fun start()

Starts lifecycle-managed transport resources.

abstract suspend fun stop()

Stops lifecycle-managed transport resources.

fun OneBotV11Client.v11Api(): OneBotV11Api

Creates a OneBotV11Api wrapper from an existing OneBotV11Client.