Interface IWebhookClient

Namespace

Kook.Net.Webhooks

Assembly

Kook.Net.Webhook.dll

表示一个通用的基于 Webhook 的网关客户端。

public interface IWebhookClient : IDisposable

Inherited Members

IDisposable.Dispose()

Methods

HandleBinaryMessageAsync(byte[], int, int)

处理二进制消息。

Task<string?> HandleBinaryMessageAsync(byte[] data, int index, int count)

Parameters

data byte[]

消息的二进制数据。

index int

数据的起始索引。

count int

数据的长度。

Returns

Task<string>

一个表示异步操作的任务。任务的结果是一个字符串，表示响应消息。

HandleTextMessageAsync(string)

处理文本消息。

Task<string?> HandleTextMessageAsync(string requestBody)

Parameters

requestBody string

请求体。

Returns

Task<string>

一个表示异步操作的任务。任务的结果是一个字符串，表示响应消息。

Events

BinaryMessage

当接收到二进制消息时引发。

event Func<byte[], int, int, Task<string?>>? BinaryMessage

Event Type

Func<byte[], int, int, Task<string>>

Remarks

事件参数：

1. byte[] 参数是消息的二进制数据。
2. int 参数是数据的起始索引。
3. int 参数是数据的长度。

事件返回值：返回一个表示异步操作的任务。任务的结果是一个字符串，表示响应消息。

Closed

当连接关闭时引发。

event Func<Exception, Task>? Closed

Event Type

Func<Exception, Task>

Remarks

事件参数：

1. Exception 参数是引发关闭的异常。

TextMessage

当接收到文本消息时引发。

event Func<string, Task<string?>>? TextMessage

Event Type

Func<string, Task<string>>

Remarks

事件参数：

1. string 参数是消息的文本。

事件返回值：返回一个表示异步操作的任务。任务的结果是一个字符串，表示响应消息。