simbot-component-kook-api/love.forte.simbot.kook.event/Signal

Signal

sealed class Signal<T>

Kook websocket概述 - 信令

信令基本格式：

{
    "s" : 1,  // int, 信令，详情参考信令说明
    "d" : [], // 数据字段mixed
    "sn" : 0, // int, 该字段并不一定有，只在s=0时有，与webhook一致。
}

Types

Event

data class Event(val s: Int = S_CODE, val d: JsonElement, val sn: Long) : Signal<JsonElement>

方向： server->client 说明：在正常连接状态下，收到的消息事件等。参数列表：

Hello

data class Hello(val d: Signal.HelloPack) : Signal<Signal.HelloPack>

方向： server->client

HelloPack

data class HelloPack(val code: Long, val sessionId: String)

Ping

data class Ping(val sn: Long) : Signal<Unit>

信令2 - PING

Pong

object Pong : Signal<Unit>

方向： server -> client

Reconnect

data class Reconnect(val d: Signal.ReconnectPack) : Signal<Signal.ReconnectPack>

方向： server->client

ReconnectCode

enum ReconnectCode : Enum<Signal.ReconnectCode>

响应值

ReconnectPack

data class ReconnectPack(val code: Int, val err: String? = null)

Resume

data class Resume(val sn: Int) : Signal<Unit>

当链接未断开时，客户端需传入当前收到的最后一个 sn 序号例:

ResumeAck

data class ResumeAck(val s: Int = S_CODE, val d: Signal.ResumeAckPack) : Signal<Signal.ResumeAckPack>

方向： server->client

ResumeAckPack

data class ResumeAckPack(val sessionId: String)

ResumeAck.d 的数据体.

Properties

abstract val d: T

数据字段mixed

abstract val s: Int

int, 信令，详情参考信令说明

Inheritors

Extensions

data

val <T> Signal<T>.data: T