SDK 與 API 概覽

一套線上協定，三個一等 SDK。

Rust 是參考引擎；Kotlin 透過 UniFFI 原生共享它，TypeScript 則是道地的 WebSocket 實作。三個 SDK 實作同一套線上協定，並共享跨語言編解碼測試夾具。

開發者體驗

連線、驗證、訂閱 — 核心流程就這三步。

下方程式碼展示真實的 API 形狀：連線、驗證、訂閱。完整建置請從各儲存庫 README 開始。

TypeScript API 概覽

$ # npm package coming soon — build from source: github.com/privchat/privchat-sdk-typescript

import { PrivchatClient } from "@privchat/sdk";

const client = new PrivchatClient({
  url: "wss://im.example.com:9080/",
});

await client.connect();
await client.authenticate(userId, accessToken, deviceId);

await client.subscribeChannel("900710001", 1);
client.onPushMessage((message) => {
  console.log("new message", message.server_message_id);
});

三條軌道

底層同一套協定，上層各自道地。

選擇適合你產品面的語言 — 線上契約是共享的，每個 SDK 對同一個伺服器說同一套協定。

Rust 核心

參考客戶端引擎：actor 命令佇列、SQLite 與 Sled 本地儲存、同步、事件廣播與 FFI 介面。

TypeScript

瀏覽器與桌面執行時：型別化編解碼、RPC 語法糖、事件重放、自動重連與令牌重新整理開箱即用。

Kotlin 多平臺

Android 與原生目標由 Rust 引擎透過 UniFFI 驅動 — 每個移動應用底下是同一個引擎。

能力矩陣

當前 SDK 家族的能力全景。

這些是已交付的能力，不是願望清單 — 未來的軌道在下方路線圖條裡，直到成真為止。

平臺

Web（WebSocket）
Android（Kotlin）
iOS（Kotlin/Native FFI）
桌面（TypeScript）
Cocos 與遊戲引擎

連線

自動重連
令牌重新整理流程
多傳輸（Rust 核心；Web 端為 WS）
連線狀態機
端到端心跳

資料

本地優先儲存
訊息同步與恢復
服務端權威序列
事件重放
型別化編解碼

擴充套件性

Transfer RPC 呼叫
Channel 訂閱與釋出
推送訊息鉤子
機器人與系統賬號 API
面向新宿主的 FFI 介面

路線圖Swift SDKGo service SDKFlutter bindingsUnity adapterCloud offeringHosted console

下一步

從指南路徑與儲存庫開始。

沿指南路徑進入各個儲存庫 — 伺服器、SDK 與協定 — 從 README 開始建置。

開啟教程

一套線上協定， 三個一等 SDK。