onebot-v12-lib/cn.qfys521.onebot.v12.lib.api/OneBotClient

OneBotClient

interface OneBotClient

Core OneBot V12 client abstraction.

It exposes a typed event stream and generic action invocation.

Inheritors

DefaultOneBotClient

Properties

abstract val events: Flow<OneBotEvent>

Stream of typed OneBot 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: String): ApiResponse<JsonObject>

Calls delete_message.

abstract suspend fun getSelfInfo(): ApiResponse<SelfInfo>

Calls get_self_info.

listenEventsAnnotated

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

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

abstract suspend fun sendMessage(request: SendMessageRequest): ApiResponse<SendMessageResult>

Calls send_message.

abstract suspend fun start()

Starts lifecycle-managed transport resources.

abstract suspend fun stop()

Stops lifecycle-managed transport resources.

fun OneBotClient.v12Api(): OneBotV12Api

Creates a full OneBotV12Api wrapper from an existing OneBotClient.