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

DefaultOneBotV11Client

class DefaultOneBotV11Client(transport: OneBotV11Transport, json: Json = OneBotV11Json.default) : OneBotV11Client

Default OneBotV11Client implementation backed by a OneBotV11Transport.

Constructors

DefaultOneBotV11Client

constructor(transport: OneBotV11Transport, json: Json = OneBotV11Json.default)

Properties

open override val events: Flow<OneBotV11Event>

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

open override val isStarted: Boolean

Whether underlying transport lifecycle has started.

Functions

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

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

open suspend override fun close()

Releases transport resources.

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

Calls delete_msg.

open suspend override 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

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

Calls send_group_msg.

sendPrivateMessage

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

Calls send_private_msg.

open suspend override fun start()

Starts lifecycle-managed transport resources.

open suspend override fun stop()

Stops lifecycle-managed transport resources.

fun OneBotV11Client.v11Api(): OneBotV11Api

Creates a OneBotV11Api wrapper from an existing OneBotV11Client.